feat(criterion): Add inspector criterion on colocation of points for meshes

Author: MelchiorSchuh

include/geode/inspector/criterion/colocation/edgedcurve_colocation.h

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2019 - 2021 Geode-solutions
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+#pragma once
+
+#include <geode/basic/pimpl.h>
+
+#include <geode/inspector/common.h>
+
+namespace geode
+{
+    FORWARD_DECLARATION_DIMENSION_CLASS( EdgedCurve );
+} // namespace geode
+
+namespace geode
+{
+    /*!
+     * Class for inspecting the colocation of points in an EdgedCurve
+     */
+    template < index_t dimension >
+    class opengeode_inspector_inspector_api EdgedCurveColocation
+    {
+        OPENGEODE_DISABLE_COPY( EdgedCurveColocation );
+
+    public:
+        EdgedCurveColocation( const EdgedCurve< dimension >& mesh );
+        ~EdgedCurveColocation();
+
+        bool mesh_has_colocated_points() const;
+
+        index_t nb_colocated_points() const;
+
+        std::vector< std::vector< index_t > > colocated_points_groups() const;
+
+    private:
+        IMPLEMENTATION_MEMBER( impl_ );
+    };
+    ALIAS_2D_AND_3D( EdgedCurveColocation );
+} // namespace geode

include/geode/inspector/criterion/colocation/pointset_colocation.h

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2019 - 2021 Geode-solutions
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+#pragma once
+
+#include <geode/basic/pimpl.h>
+
+#include <geode/inspector/common.h>
+
+namespace geode
+{
+    FORWARD_DECLARATION_DIMENSION_CLASS( PointSet );
+} // namespace geode
+
+namespace geode
+{
+    /*!
+     * Class for inspecting the colocation of points in a PointSet
+     */
+    template < index_t dimension >
+    class opengeode_inspector_inspector_api PointSetColocation
+    {
+        OPENGEODE_DISABLE_COPY( PointSetColocation );
+
+    public:
+        PointSetColocation( const PointSet< dimension >& mesh );
+        ~PointSetColocation();
+
+        bool mesh_has_colocated_points() const;
+
+        index_t nb_colocated_points() const;
+
+        std::vector< std::vector< index_t > > colocated_points_groups() const;
+
+    private:
+        IMPLEMENTATION_MEMBER( impl_ );
+    };
+    ALIAS_2D_AND_3D( PointSetColocation );
+} // namespace geode

include/geode/inspector/criterion/colocalization/solid_colocalization.h renamed to include/geode/inspector/criterion/colocation/solid_colocation.h

@@ -35,24 +35,25 @@ namespace geode
 namespace geode
 {
     /*!
-     * Class for inspecting the colocalization of points in a mesh
+     * Class for inspecting the colocation of points in a SolidMesh
      */
     template < index_t dimension >
-    class opengeode_inspector_inspector_api SolidMeshColocalization
+    class opengeode_inspector_inspector_api SolidMeshColocation
     {
+        OPENGEODE_DISABLE_COPY( SolidMeshColocation );
+
     public:
-        SolidMeshColocalization( const SolidMesh< dimension >& mesh );
-        ~SolidMeshColocalization();
+        SolidMeshColocation( const SolidMesh< dimension >& mesh );
+        ~SolidMeshColocation();
 
-        bool mesh_has_colocalized_points() const;
+        bool mesh_has_colocated_points() const;
 
-        index_t nb_colocalized_points() const;
+        index_t nb_colocated_points() const;
 
-        const std::vector< std::vector< index_t > >
-            colocalized_points_groups() const;
+        std::vector< std::vector< index_t > > colocated_points_groups() const;
 
     private:
         IMPLEMENTATION_MEMBER( impl_ );
     };
-    ALIAS_2D_AND_3D( SolidMeshColocalization );
+    ALIAS_2D_AND_3D( SolidMeshColocation );
 } // namespace geode

include/geode/inspector/criterion/colocalization/surface_colocalization.h renamed to include/geode/inspector/criterion/colocation/surface_colocation.h

@@ -35,24 +35,25 @@ namespace geode
 namespace geode
 {
     /*!
-     * Class for inspecting the colocalization of points in a mesh
+     * Class for inspecting the colocation of points in a SurfaceMesh
      */
     template < index_t dimension >
-    class opengeode_inspector_inspector_api SurfaceMeshColocalization
+    class opengeode_inspector_inspector_api SurfaceMeshColocation
     {
+        OPENGEODE_DISABLE_COPY( SurfaceMeshColocation );
+
     public:
-        SurfaceMeshColocalization( const SurfaceMesh< dimension >& mesh );
-        ~SurfaceMeshColocalization();
+        SurfaceMeshColocation( const SurfaceMesh< dimension >& mesh );
+        ~SurfaceMeshColocation();
 
-        bool mesh_has_colocalized_points() const;
+        bool mesh_has_colocated_points() const;
 
-        index_t nb_colocalized_points() const;
+        index_t nb_colocated_points() const;
 
-        const std::vector< std::vector< index_t > >
-            colocalized_points_groups() const;
+        std::vector< std::vector< index_t > > colocated_points_groups() const;
 
     private:
         IMPLEMENTATION_MEMBER( impl_ );
     };
-    ALIAS_2D_AND_3D( SurfaceMeshColocalization );
+    ALIAS_2D_AND_3D( SurfaceMeshColocation );
 } // namespace geode

include/geode/inspector/criterion/degeneration/edgedcurve_degeneration.h

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2019 - 2021 Geode-solutions
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+#pragma once
+
+#include <geode/basic/pimpl.h>
+
+#include <geode/inspector/common.h>
+
+namespace geode
+{
+    FORWARD_DECLARATION_DIMENSION_CLASS( EdgedCurve );
+} // namespace geode
+
+namespace geode
+{
+    /*!
+     * Class for inspecting the degeneration of an EdgedCurve
+     */
+    template < index_t dimension >
+    class opengeode_inspector_inspector_api EdgedCurveDegeneration
+    {
+        OPENGEODE_DISABLE_COPY( EdgedCurveDegeneration );
+
+    public:
+        EdgedCurveDegeneration( const EdgedCurve< dimension >& mesh );
+        ~EdgedCurveDegeneration();
+
+        bool is_mesh_degenerated() const;
+
+        index_t nb_degenerated_edges() const;
+
+        std::vector< index_t > degenerated_edges() const;
+
+    private:
+        IMPLEMENTATION_MEMBER( impl_ );
+    };
+    ALIAS_2D_AND_3D( EdgedCurveDegeneration );
+} // namespace geode

include/geode/inspector/criterion/degeneration/solid_degeneration.h

@@ -30,20 +30,20 @@
 namespace geode
 {
     FORWARD_DECLARATION_DIMENSION_CLASS( SolidMesh );
-    ALIAS_3D( SolidMesh );
 } // namespace geode
 
 namespace geode
 {
     /*!
      * Class for inspecting the degeneration of a SolidMesh
      */
+    template < index_t dimension >
     class opengeode_inspector_inspector_api SolidMeshDegeneration
     {
         OPENGEODE_DISABLE_COPY( SolidMeshDegeneration );
 
     public:
-        SolidMeshDegeneration( const SolidMesh3D& mesh );
+        SolidMeshDegeneration( const SolidMesh< dimension >& mesh );
         ~SolidMeshDegeneration();
 
         bool is_mesh_degenerated() const;
@@ -55,4 +55,5 @@ namespace geode
     private:
         IMPLEMENTATION_MEMBER( impl_ );
     };
-} // namespace geode
+    ALIAS_2D_AND_3D( SolidMeshDegeneration );
+} // namespace geode

include/geode/inspector/criterion/private/colocalization_impl.h renamed to include/geode/inspector/criterion/private/colocation_impl.h

@@ -25,34 +25,31 @@
 
 #include <geode/inspector/common.h>
 
+#include <geode/geometry/nn_search.h>
+
 namespace geode
 {
     namespace detail
     {
         /*!
-         * Implementation of the inspection of the colocalization of a Mesh
+         * Implementation of the inspection of the colocation of a Mesh
          */
-        template < class MeshType >
-        class opengeode_inspector_inspector_api ColocalizationImpl
+        template < index_t dimension, class MeshType >
+        class ColocationImpl
         {
-            OPENGEODE_DISABLE_COPY( ColocalizationImpl );
-
         public:
-            ColocalizationImpl( const MeshType& mesh );
-            ~ColocalizationImpl();
+            ColocationImpl( const MeshType& mesh );
 
-            bool mesh_has_colocalized_points() const;
+            bool mesh_has_colocated_points() const;
 
-            index_t nb_colocalized_points() const;
+            index_t nb_colocated_points() const;
 
             std::vector< std::vector< index_t > >
-                colocalized_points_groups() const;
+                colocated_points_groups() const;
 
         private:
-            bool points_are_colocalized(
-                index_t pt_index_1, index_t pt_index_2 ) const;
-
-            const MeshType& mesh_;
+            const typename NNSearch< dimension >::ColocatedInfo
+                mesh_colocation_info_;
         };
     } // namespace detail
 } // namespace geode

include/geode/inspector/criterion/private/degeneration_impl.h

@@ -33,10 +33,8 @@ namespace geode
          * Implementation of the inspection of the degeneration of a Mesh
          */
         template < class MeshType >
-        class opengeode_inspector_inspector_api DegenerationImpl
+        class DegenerationImpl
         {
-            OPENGEODE_DISABLE_COPY( DegenerationImpl );
-
         public:
             DegenerationImpl( const MeshType& mesh );
 

src/geode/inspector/CMakeLists.txt

@@ -23,15 +23,27 @@ add_geode_library(
     FOLDER "geode/inspector"
     SOURCES
         "common.cpp"
+        "criterion/degeneration/edgedcurve_degeneration.cpp"
         "criterion/degeneration/surface_degeneration.cpp"
         "criterion/degeneration/solid_degeneration.cpp"
         "criterion/private/degeneration_impl.cpp"
+        "criterion/colocation/pointset_colocation.cpp"
+        "criterion/colocation/edgedcurve_colocation.cpp"
+        "criterion/colocation/surface_colocation.cpp"
+        "criterion/colocation/solid_colocation.cpp"
+        "criterion/private/colocation_impl.cpp"
     PUBLIC_HEADERS
         "common.h"
+        "criterion/degeneration/edgedcurve_degeneration.h"
         "criterion/degeneration/surface_degeneration.h"
         "criterion/degeneration/solid_degeneration.h"
+        "criterion/colocation/pointset_colocation.h"
+        "criterion/colocation/edgedcurve_colocation.h"
+        "criterion/colocation/surface_colocation.h"
+        "criterion/colocation/solid_colocation.h"
     PRIVATE_HEADERS
         "criterion/private/degeneration_impl.h"
+        "criterion/private/colocation_impl.h"
     PUBLIC_DEPENDENCIES
         OpenGeode::basic
     PRIVATE_DEPENDENCIES