EE class

EE class. More...

Files
file	ves.h
	Class V,E,S: the fundamental simplex geometry objects.
Classes
struct	sEE
	Class EE: Definition (8+20=28 bytes). More...
Typedefs
typedef struct sEE	EE
	Declaration of the EE class as the EE structure.
Functions
void	EE_init (EE *thee, int dim, int id)
	Initialize an edge.
void	EE_reinit (EE *thee)
	Re-initialize an edge.
void	EE_setReality (EE *thee, int type)
	Set the reality.
void	EE_setDim (EE *thee, int dim)
	Set the dimension.
void	EE_setClass (EE *thee, int type)
	Set the class.
void	EE_setType (EE *thee, int type)
	Set the type.
void	EE_setChart (EE *thee, int chart)
	Set the chart.
void	EE_setId (EE *thee, int id)
	Set the ID.
unsigned int	EE_dim (EE *thee)
	Return the dimension.
unsigned int	EE_dimVV (EE *thee)
	Return the number of vertices in a simplex.
unsigned int	EE_dimEE (EE *thee)
	Return the number of edges in a simplex.
unsigned int	EE_dimFF (EE *thee)
	Return the number of faces in a simplex.
unsigned int	EE_reality (EE *thee)
	Return the reality.
unsigned int	EE_class (EE *thee)
	Return the class.
unsigned int	EE_type (EE *thee)
	Return the type.
unsigned int	EE_chart (EE *thee)
	Return the chart.
unsigned int	EE_id (EE *thee)
	Return the ID.
void	EE_setVertex (EE *thee, int i, VV *vx)
	Set one of the two vertices.
void	EE_setMidPoint (EE *thee, VV *vx)
	Set the midpoint of the edge.
void	EE_setParent (EE *thee, EE *eg)
	Set the parent edge pointer.
void	EE_setVertexOrder (EE *thee, VV *vxTmp)
	Set the vertex order.
void	EE_setLink (EE *thee, VV *vx, EE *eg)
	Set the next edge pointer associated with one of the vertices.
VV *	EE_vertex (EE *thee, int i)
	Return one of the vertices.
VV *	EE_midPoint (EE *thee)
	Return the midpoint of the edge.
EE *	EE_parent (EE *thee)
	Return the parent edge pointer.
VV *	EE_otherVertex (EE *thee, VV *vx)
	Return the vertex not matching the input vertex.
EE *	EE_link (EE *thee, VV *vx)
	Return the next edge in the ring around a given vertex.
EE *	EE_ctor (int dim, int myid)
	The edge constructor.
void	EE_dtor (EE **thee)
	The edge destructor.
void	EE_initRing (EE *thee)
	Initialize the edge rings.
void	EE_meltRing (EE *thee)
	Destroy the edge rings.
void	EE_buildRing (EE *thee)
	Build the edge rings.

---

Detailed Description

EE class.

---

Typedef Documentation

typedef struct sEE EE

Declaration of the EE class as the EE structure.

Author:

Michael Holst

---

Function Documentation

void EE_buildRing

(

EE *

thee

)

Build the edge rings.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

thee

Pointer to an edge

unsigned int EE_chart

(

EE *

thee

)

Return the chart.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the chart

Parameters:

thee

Pointer to an edge

unsigned int EE_class

(

EE *

thee

)

Return the class.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the class

Parameters:

thee

Pointer to an edge

EE* EE_ctor	(	int	dim,
		int	myid
	)

The edge constructor.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

Pointer to a new allocated edge

Parameters:

	dim	the dimension bits
	myid	the ID bits

unsigned int EE_dim

(

EE *

thee

)

Return the dimension.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the dimension.

Parameters:

thee

Pointer to an edge

unsigned int EE_dimEE

(

EE *

thee

)

Return the number of edges in a simplex.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the number of edges in a simplex.

Parameters:

thee

Pointer to an edge

unsigned int EE_dimFF

(

EE *

thee

)

Return the number of faces in a simplex.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the number of faces in a simplex.

Parameters:

thee

Pointer to an edge

unsigned int EE_dimVV

(

EE *

thee

)

Return the number of vertices in a simplex.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the number of vertices in a simplex.

Parameters:

thee

Pointer to an edge

void EE_dtor

(

EE **

thee

)

The edge destructor.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

thee

Pointer to an edge

unsigned int EE_id

(

EE *

thee

)

Return the ID.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the ID

Parameters:

thee

Pointer to an edge

void EE_init	(	EE *	thee,
		int	dim,
		int	id
	)

Initialize an edge.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

	thee	Pointer to an edge
	dim	the dimension bits
	id	the ID bits

void EE_initRing

(

EE *

thee

)

Initialize the edge rings.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

thee

Pointer to an edge

EE* EE_link	(	EE *	thee,
		VV *	vx
	)

Return the next edge in the ring around a given vertex.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the next edge in the ring around a given vertex.

Parameters:

	thee	Pointer to an edge
	vx	Pointer to a vertex

void EE_meltRing

(

EE *

thee

)

Destroy the edge rings.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

thee

Pointer to an edge

VV* EE_midPoint

(

EE *

thee

)

Return the midpoint of the edge.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the midpoint of the edge.

Parameters:

thee

Pointer to an edge

VV* EE_otherVertex	(	EE *	thee,
		VV *	vx
	)

Return the vertex not matching the input vertex.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the vertex not matching the input vertex.

Parameters:

	thee	Pointer to an edge
	vx	Pointer to a vertex

EE* EE_parent

(

EE *

thee

)

Return the parent edge pointer.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the parent edge pointer.

Parameters:

thee

Pointer to an edge

unsigned int EE_reality

(

EE *

thee

)

Return the reality.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the reality

Parameters:

thee

Pointer to an edge

void EE_reinit

(

EE *

thee

)

Re-initialize an edge.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

thee

Pointer to an edge

void EE_setChart	(	EE *	thee,
		int	chart
	)

Set the chart.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

	thee	Pointer to a vertex
	chart	the chart bits

void EE_setClass	(	EE *	thee,
		int	type
	)

Set the class.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

	thee	Pointer to an edge
	type	the class bits

void EE_setDim	(	EE *	thee,
		int	dim
	)

Set the dimension.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

	thee	Pointer to an edge
	dim	the dimension bits

void EE_setId	(	EE *	thee,
		int	id
	)

Set the ID.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

	thee	Pointer to an edge
	id	the ID bits

void EE_setLink	(	EE *	thee,
		VV *	vx,
		EE *	eg
	)

Set the next edge pointer associated with one of the vertices.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

	thee	Pointer to an edge
	vx	Pointer to a vertex
	eg	Pointer to an edge

void EE_setMidPoint	(	EE *	thee,
		VV *	vx
	)

Set the midpoint of the edge.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

	thee	Pointer to an edge
	vx	Pointer to a vertex

void EE_setParent	(	EE *	thee,
		EE *	eg
	)

Set the parent edge pointer.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

	thee	Pointer to an edge
	eg	Pointer to an edge

void EE_setReality	(	EE *	thee,
		int	type
	)

Set the reality.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

	thee	Pointer to an edge
	type	the reality bits

void EE_setType	(	EE *	thee,
		int	type
	)

Set the type.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

	thee	Pointer to an edge
	type	the type bits

void EE_setVertex	(	EE *	thee,
		int	i,
		VV *	vx
	)

Set one of the two vertices.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

	thee	Pointer to an edge
	i	index for a vertex
	vx	Pointer to a vertex

void EE_setVertexOrder	(	EE *	thee,
		VV *	vxTmp
	)

Set the vertex order.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

None

Parameters:

	thee	Pointer to an edge
	vxTmp	Pointer to a vertex

unsigned int EE_type

(

EE *

thee

)

Return the type.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

the type

Parameters:

thee

Pointer to an edge

VV* EE_vertex	(	EE *	thee,
		int	i
	)

Return one of the vertices.

Author:

Michael Holst

Note:

Class E: Inlineable methods (ves.c)

Returns:

one of the vertcies.

Parameters:

	thee	Pointer to an edge
	i	index for a vertex