Copyright	(c) Stéphane Laurent 2023
License	GPL-3
Maintainer	laurent_step@outlook.fr
Safe Haskell	Safe-Inferred
Language	Haskell2010

Geometry.ConvexHull

Description

See README for examples.

Synopsis

class HasCenter m where
- _center :: m -> [Double]
class HasVolume m where
- _volume :: m -> Double
class HasEdges m where
- _edges :: m -> EdgeMap
class HasVertices m where
- _vertices :: m -> IndexMap [Double]
class HasNormal m where
- _normal :: m -> [Double]
- _offset :: m -> Double
class HasFamily m where
- _family :: m -> Family
data Family
- = Family Int
- | None
type EdgeMap = InsOrdHashMap IndexPair ([Double], [Double])
data IndexPair = Pair Index Index
type IndexSet = IntSet
type IndexMap = IntMap
type Index = Int
verticesIds :: HasVertices a => a -> [Index]
verticesCoordinates :: HasVertices a => a -> [[Double]]
nVertices :: HasVertices a => a -> Int
edgesIds :: HasEdges a => a -> [IndexPair]
edgesIds' :: HasEdges a => a -> [(Index, Index)]
edgesCoordinates :: HasEdges a => a -> [([Double], [Double])]
nEdges :: HasEdges a => a -> Int
isEdge :: HasEdges a => a -> (Index, Index) -> Bool
toPoints :: HasEdges a => a -> (Index, Index) -> Maybe ([Double], [Double])
toPoints' :: HasEdges a => a -> (Index, Index) -> ([Double], [Double])
data ConvexHull = ConvexHull {
- _hvertices :: IndexMap Vertex
- _hfacets :: IntMap Facet
- _hridges :: IntMap Ridge
- _hedges :: EdgeMap
- _simplicial :: Bool
- _dimension :: Int
}
data Facet = Facet {
- _fvertices :: IndexMap [Double]
- _fridges :: IntSet
- _centroid :: [Double]
- _normal' :: [Double]
- _offset' :: Double
- _orientation' :: Int
- _area :: Double
- _neighbors :: IntSet
- _family' :: Family
- _fedges :: EdgeMap
}
data Ridge = Ridge {
- _rvertices :: IndexMap [Double]
- _ridgeOf :: IntSet
- _redges :: EdgeMap
}
data Vertex = Vertex {
- _point :: [Double]
- _neighfacets :: IntSet
- _neighvertices :: IndexSet
- _neighridges :: IntSet
}
convexHull :: [[Double]] -> Bool -> Bool -> Maybe FilePath -> IO ConvexHull
hullSummary :: ConvexHull -> String
hullVolume :: ConvexHull -> Double
edgeOf :: ConvexHull -> (Index, Index) -> [Int]
facetRidges :: ConvexHull -> Facet -> IntMap Ridge
facetsVerticesIds :: ConvexHull -> [[Index]]
ridgesVerticesIds :: ConvexHull -> [[Index]]
groupedFacets :: ConvexHull -> [(Family, [IndexMap [Double]], [EdgeMap])]
groupedFacets' :: ConvexHull -> [(Family, IndexMap [Double], EdgeMap)]
facetToPolygon :: Facet -> ([(Index, [Double])], Bool)
facetToPolygon' :: Facet -> [(Index, [Double])]
ridgeToPolygon :: Ridge -> [(Index, [Double])]
hullToSTL :: ConvexHull -> FilePath -> IO ()

Documentation

class HasCenter m where Source #

Methods

_center :: m -> [Double] Source #

Instances

Instances details

HasCenter Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _center :: Facet -> [Double] Source #

class HasVolume m where Source #

Methods

_volume :: m -> Double Source #

Instances

Instances details

HasVolume Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _volume :: Facet -> Double Source #

class HasEdges m where Source #

Methods

_edges :: m -> EdgeMap Source #

Instances

Instances details

HasEdges ConvexHull Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _edges :: ConvexHull -> EdgeMap Source #
HasEdges Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _edges :: Facet -> EdgeMap Source #
HasEdges Ridge Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _edges :: Ridge -> EdgeMap Source #

class HasVertices m where Source #

Methods

_vertices :: m -> IndexMap [Double] Source #

Instances

Instances details

HasVertices ConvexHull Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _vertices :: ConvexHull -> IndexMap [Double] Source #
HasVertices Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _vertices :: Facet -> IndexMap [Double] Source #
HasVertices Ridge Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _vertices :: Ridge -> IndexMap [Double] Source #

class HasNormal m where Source #

Methods

_normal :: m -> [Double] Source #

_offset :: m -> Double Source #

Instances

Instances details

HasNormal Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _normal :: Facet -> [Double] Source # _offset :: Facet -> Double Source #

class HasFamily m where Source #

Methods

_family :: m -> Family Source #

Instances

Instances details

HasFamily Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _family :: Facet -> Family Source #

data Family Source #

Constructors

Family Int
None

Instances

Instances details

Read Family Source #
Instance details Defined in Geometry.Qhull.Types Methods readsPrec :: Int -> ReadS Family # readList :: ReadS [Family] # readPrec :: ReadPrec Family # readListPrec :: ReadPrec [Family] #
Show Family Source #
Instance details Defined in Geometry.Qhull.Types Methods showsPrec :: Int -> Family -> ShowS # show :: Family -> String # showList :: [Family] -> ShowS #
Eq Family Source #
Instance details Defined in Geometry.Qhull.Types Methods (==) :: Family -> Family -> Bool # (/=) :: Family -> Family -> Bool #

type EdgeMap = InsOrdHashMap IndexPair ([Double], [Double]) Source #

data IndexPair Source #

Constructors

Pair Index Index

Instances

Instances details

Read IndexPair Source #
Instance details Defined in Geometry.Qhull.Types Methods readsPrec :: Int -> ReadS IndexPair # readList :: ReadS [IndexPair] # readPrec :: ReadPrec IndexPair # readListPrec :: ReadPrec [IndexPair] #
Show IndexPair Source #
Instance details Defined in Geometry.Qhull.Types Methods showsPrec :: Int -> IndexPair -> ShowS # show :: IndexPair -> String # showList :: [IndexPair] -> ShowS #
Eq IndexPair Source #
Instance details Defined in Geometry.Qhull.Types Methods (==) :: IndexPair -> IndexPair -> Bool # (/=) :: IndexPair -> IndexPair -> Bool #
Hashable IndexPair Source #
Instance details Defined in Geometry.Qhull.Types Methods hashWithSalt :: Int -> IndexPair -> Int # hash :: IndexPair -> Int #

type IndexSet = IntSet Source #

type IndexMap = IntMap Source #

type Index = Int Source #

verticesIds :: HasVertices a => a -> [Index] Source #

vertices ids

verticesCoordinates :: HasVertices a => a -> [[Double]] Source #

vertices coordinates

nVertices :: HasVertices a => a -> Int Source #

number of vertices

edgesIds :: HasEdges a => a -> [IndexPair] Source #

edges ids

edgesIds' :: HasEdges a => a -> [(Index, Index)] Source #

edges ids as pairs of integers

edgesCoordinates :: HasEdges a => a -> [([Double], [Double])] Source #

edges coordinates

nEdges :: HasEdges a => a -> Int Source #

number of edges

isEdge :: HasEdges a => a -> (Index, Index) -> Bool Source #

whether a pair of vertices indices form an edge; the order of the indices has no importance

toPoints :: HasEdges a => a -> (Index, Index) -> Maybe ([Double], [Double]) Source #

edge as pair of points; the order of the vertices has no importance

toPoints' :: HasEdges a => a -> (Index, Index) -> ([Double], [Double]) Source #

edge as pair of points, without checking the edge exists

data ConvexHull Source #

Constructors

ConvexHull
Fields _hvertices :: IndexMap Vertex _hfacets :: IntMap Facet _hridges :: IntMap Ridge _hedges :: EdgeMap _simplicial :: Bool _dimension :: Int

Instances

Instances details

Show ConvexHull Source #
Instance details Defined in Geometry.ConvexHull.Types Methods showsPrec :: Int -> ConvexHull -> ShowS # show :: ConvexHull -> String # showList :: [ConvexHull] -> ShowS #
HasEdges ConvexHull Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _edges :: ConvexHull -> EdgeMap Source #
HasVertices ConvexHull Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _vertices :: ConvexHull -> IndexMap [Double] Source #

data Facet Source #

Constructors

Facet
Fields _fvertices :: IndexMap [Double] _fridges :: IntSet _centroid :: [Double] _normal' :: [Double] _offset' :: Double _orientation' :: Int _area :: Double _neighbors :: IntSet _family' :: Family _fedges :: EdgeMap

Instances

data Ridge Source #

Constructors

Ridge
Fields _rvertices :: IndexMap [Double] _ridgeOf :: IntSet _redges :: EdgeMap

Instances

Instances details

Show Ridge Source #
Instance details Defined in Geometry.ConvexHull.Types Methods showsPrec :: Int -> Ridge -> ShowS # show :: Ridge -> String # showList :: [Ridge] -> ShowS #
HasEdges Ridge Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _edges :: Ridge -> EdgeMap Source #
HasVertices Ridge Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _vertices :: Ridge -> IndexMap [Double] Source #

data Vertex Source #

Constructors

Vertex
Fields _point :: [Double] _neighfacets :: IntSet _neighvertices :: IndexSet _neighridges :: IntSet

Instances

Instances details

Show Vertex Source #
Instance details Defined in Geometry.ConvexHull.Types Methods showsPrec :: Int -> Vertex -> ShowS # show :: Vertex -> String # showList :: [Vertex] -> ShowS #

convexHull Source #

Arguments

:: [[Double]]	vertices
-> Bool	whether to triangulate
-> Bool	whether to print output to stdout
-> Maybe FilePath	write summary to a file
-> IO ConvexHull

hullSummary :: ConvexHull -> String Source #

convex hull summary

hullVolume :: ConvexHull -> Double Source #

volume of the convex hull (area in dimension 2, volume in dimension 3, hypervolume in higher dimension)

edgeOf :: ConvexHull -> (Index, Index) -> [Int] Source #

facets ids an edge belongs to

facetRidges :: ConvexHull -> Facet -> IntMap Ridge Source #

ridges of a facet

facetsVerticesIds :: ConvexHull -> [[Index]] Source #

vertices ids of all facets

ridgesVerticesIds :: ConvexHull -> [[Index]] Source #

vertices ids of all ridges

groupedFacets :: ConvexHull -> [(Family, [IndexMap [Double]], [EdgeMap])] Source #

group facets of the same family

groupedFacets' :: ConvexHull -> [(Family, IndexMap [Double], EdgeMap)] Source #

group facets of the same family and merge vertices and edges

facetToPolygon :: Facet -> ([(Index, [Double])], Bool) Source #

for 3D only, orders the vertices of the facet (i.e. provides a polygon); also returns a Boolean indicating the orientation of the vertices

facetToPolygon' :: Facet -> [(Index, [Double])] Source #

for 3D only, orders the vertices of the facet (i.e. provides a polygon) in anticlockwise orientation

ridgeToPolygon :: Ridge -> [(Index, [Double])] Source #

for 4D only, orders the vertices of a ridge (i.e. provides a polygon)

hullToSTL :: ConvexHull -> FilePath -> IO () Source #

for 3D only, convert the convex hull to a STL file; the STL format is valid for triangle meshes only

Show Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods showsPrec :: Int -> Facet -> ShowS # show :: Facet -> String # showList :: [Facet] -> ShowS #
HasCenter Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _center :: Facet -> [Double] Source #
HasEdges Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _edges :: Facet -> EdgeMap Source #
HasFamily Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _family :: Facet -> Family Source #
HasNormal Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _normal :: Facet -> [Double] Source # _offset :: Facet -> Double Source #
HasVertices Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _vertices :: Facet -> IndexMap [Double] Source #
HasVolume Facet Source #
Instance details Defined in Geometry.ConvexHull.Types Methods _volume :: Facet -> Double Source #