mpblocks::clarkson93::ExampleTraits Struct Reference

documents the interface for Traits : encapsulates various policies for the Triangulation More...

#include <mpblocks/clarkson93/ExampleTraits.h>

Classes
struct	Callback
	the triangulation provides some static callbacks for when hull faces are added or removed. If we wish to do anything special this is where we can hook into them. If you do not wish to hook into the callbacks then simply create an empty structure which has empty implementation for these More...
struct	PointDeref
	proves a means of turning a PointRef into a Point& More...
struct	Simplex
	The derived type to use for simplices. More...
struct	SimplexFactory
	template for allocators & memory managers More...

Public Types
typedef unsigned int	idx_t
	number format for storing indices More...
typedef Eigen::Matrix< Scalar, 2, 1 >	Point
	Data structure for representing points. More...
typedef const Point *	PointRef
	a reference to a point More...
typedef double	Scalar
	number format for scalar numbers More...

Static Public Attributes
static const unsigned int	NDim = 2
	dimension of the embeded space, use clarkson93::Dynamic for a datastructure whose dimension is set at runtime More...
static const int	OptLevel = 1
	optimization levels More...

Detailed Description

documents the interface for Traits : encapsulates various policies for the Triangulation

Todo:

Should these traits be split up into multiple policy classes?

Definition at line 42 of file ExampleTraits.h.

Member Typedef Documentation

typedef unsigned int mpblocks::clarkson93::ExampleTraits::idx_t

number format for storing indices

Definition at line 60 of file ExampleTraits.h.

typedef Eigen::Matrix<Scalar,2,1> mpblocks::clarkson93::ExampleTraits::Point

Data structure for representing points.

Currently only Eigen::Matrix<Scalar,NDim,1> is supported b/c we utilize this structure in solving a linear system. Technically anything that derives from Eigen::MatrixBase will work because it just needs to be assignable to an Eigen::Matrix::row() and from an Eigen::Vector when we solve for the normal and offset of the base facet. In the future I may generalize the solving of the linear system in which case that functionality will be a requirement of the traits class

Definition at line 76 of file ExampleTraits.h.

typedef const Point* mpblocks::clarkson93::ExampleTraits::PointRef

a reference to a point

In the example traits this is merely a pointer. This type exists to allow different methods of pointing to Point data structures. For instance you may wish to typedef PointRef as an unsigned int, and let PointRef be an index into an array of points.

See Also

ExampleTraits::PointDeref

Definition at line 87 of file ExampleTraits.h.

typedef double mpblocks::clarkson93::ExampleTraits::Scalar

number format for scalar numbers

Definition at line 63 of file ExampleTraits.h.

Member Data Documentation

const unsigned int mpblocks::clarkson93::ExampleTraits::NDim = 2

static

dimension of the embeded space, use clarkson93::Dynamic for a datastructure whose dimension is set at runtime

Definition at line 57 of file ExampleTraits.h.

const int mpblocks::clarkson93::ExampleTraits::OptLevel = 1

static

optimization levels

level	details
0	Templated Traits implementation following the paper,
1	simple optimizations that do not change the algorithm

2 |

Definition at line 53 of file ExampleTraits.h.

---

The documentation for this struct was generated from the following file:

• include/mpblocks/clarkson93/ExampleTraits.h