edelsbrunner96::ExampleTraits Struct Reference

Example of a traits class suitable for instantiation an edelsbrunner triangulation object. More...

#include <edelsbrunner96/example_traits.hpp>

Classes
class	Storage
	Storage abstraction for simplices and points. More...

Public Types
typedef Eigen::Matrix< Scalar, NDim, 1 >	Point
	the type used for a NDim point, requires some of the interface of an Eigen::Matrix. For now that is probably the only option More...
typedef Point *	PointRef
	type which points to a Point structure, this is what is stored inside simplices. Here we simply use a pointer. Alternatives may include an integer index into a buffer, or a reference counted pointer. More...
typedef double	Scalar
	numeric type for scalars More...
typedef SimplexBase < ExampleTraits >	Simplex
	the simplex type, this may be a structure with extra methods and such but it should provide the same interface as SimplexBase and I strongly recommend deriving from SimplexBase<Traits> in order to ensure this requirement More...
typedef Simplex *	SimplexRef
	How we will refer to simplices within the simplex store. For this example the simplex store is a simple vector so we'll refer to them by their index. More...

Static Public Attributes
static const unsigned int	NDim = 2
	dimension of the triangulation More...

Detailed Description

Example of a traits class suitable for instantiation an edelsbrunner triangulation object.

Definition at line 38 of file example_traits.hpp.

Member Typedef Documentation

typedef Eigen::Matrix<Scalar, NDim, 1> edelsbrunner96::ExampleTraits::Point

the type used for a NDim point, requires some of the interface of an Eigen::Matrix. For now that is probably the only option

Definition at line 47 of file example_traits.hpp.

typedef Point* edelsbrunner96::ExampleTraits::PointRef

type which points to a Point structure, this is what is stored inside simplices. Here we simply use a pointer. Alternatives may include an integer index into a buffer, or a reference counted pointer.

Must be a distinct type from SimplexRef to allow for type deduction in dereferencing. If this is an index into an array, for instance, it should be a unique type which acts like an index.

Definition at line 57 of file example_traits.hpp.

typedef double edelsbrunner96::ExampleTraits::Scalar

numeric type for scalars

Definition at line 43 of file example_traits.hpp.

typedef SimplexBase<ExampleTraits> edelsbrunner96::ExampleTraits::Simplex

the simplex type, this may be a structure with extra methods and such but it should provide the same interface as SimplexBase and I strongly recommend deriving from SimplexBase<Traits> in order to ensure this requirement

Definition at line 63 of file example_traits.hpp.

typedef Simplex* edelsbrunner96::ExampleTraits::SimplexRef

How we will refer to simplices within the simplex store. For this example the simplex store is a simple vector so we'll refer to them by their index.

Must be a distinct type from PointRef to allow for type deduction in dereferencing. If this is an index into an array, for instance, it should be a unique type which acts like an index.

Definition at line 73 of file example_traits.hpp.

Member Data Documentation

const unsigned int edelsbrunner96::ExampleTraits::NDim = 2

static

dimension of the triangulation

Definition at line 40 of file example_traits.hpp.

---

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

• include/edelsbrunner96/example_traits.hpp