VV class

VV class. More...


Files

file  ves.h
 Class V,E,S: the fundamental simplex geometry objects.

Classes

struct  sVV
 Class VV: Definition (8+32=40 bytes). More...

Typedefs

typedef struct sVV VV
 Declaration of the VV class as the VV structure.

Functions

void VV_init (VV *thee, int dim, int id)
 Intialize a vertex.
void VV_reinit (VV *thee)
 Re-intialize a vertex.
void VV_setReality (VV *thee, int type)
 Set the reality.
void VV_setDim (VV *thee, int dim)
 Set the dimension.
void VV_setClass (VV *thee, int type)
 Set the class.
void VV_setType (VV *thee, int type)
 Set the type.
void VV_setChart (VV *thee, int chart)
 Set the chart.
void VV_setId (VV *thee, int id)
 Set the ID.
unsigned int VV_reality (VV *thee)
 Return the reality.
unsigned int VV_dim (VV *thee)
 Return the dimension.
unsigned int VV_dimVV (VV *thee)
 Return the number of vertices in a simplex.
unsigned int VV_dimEE (VV *thee)
 Return the number of edges in a simplex.
unsigned int VV_dimFF (VV *thee)
 Return the number of faces in a simplex.
unsigned int VV_class (VV *thee)
 Return the class.
unsigned int VV_type (VV *thee)
 Return the type.
unsigned int VV_chart (VV *thee)
 Return the chart.
unsigned int VV_id (VV *thee)
 Return the ID.
void VV_setCoord (VV *thee, int i, double val)
 Set the coordinate.
void VV_setFirstEE (VV *thee, EE *eg)
 Set the first edge in an edge ring.
void VV_setFirstSS (VV *thee, SS *sm)
 Set the first simplex in a simplex ring.
void VV_setParentEE (VV *thee, EE *eg)
 Set the parent edge pointer.
double VV_coord (VV *thee, int i)
 Return the coordinate.
EEVV_firstEE (VV *thee)
 Set the first edge in an edge ring.
SSVV_firstSS (VV *thee)
 Set the first simplex in a simplex ring.
EEVV_parentEE (VV *thee)
 the parent edge pointer.
void VV_addEdgeToRing (VV *thee, EE *eg)
 Add an edge to an edge ring.
void VV_addSimplexToRing (VV *thee, SS *sm)
 Add a simplex to a simplex ring.
VVVV_ctor (int dim, int myid)
 The vertex constructor.
void VV_dtor (VV **thee)
 The vertex destructor.
void VV_removeEdgeFromRing (VV *thee, EE *eg)
 Remove an edge from an edge ring.
void VV_removeSimplexFromRing (VV *thee, SS *sm)
 Remove a simplex from a simplex ring.
int VV_edgeInRing (VV *thee, EE *eg)
 Is an edge in the edge ring.
int VV_simplexInRing (VV *thee, SS *sm)
 Is a simplex in a simplex ring.
EEVV_commonEdge (VV *thee, VV *v0)
 Return the common edge between two vertices.
EEVV_parentEdge (VV *thee, VV *v0)
 Return parent edge having one of two vertices as midpoint.
SSVV_commonSimplex2 (VV *thee, VV *v0, SS *sm)
 Return a 2-simplex that is shared by 2 vertices, and which is different from the input simplex sm.
SSVV_commonSimplex3 (VV *thee, VV *v0, VV *v1, SS *sm)
 Return a 3-simplex that is shared by 3 vertices, and which is different from the input simplex sm.
SSVV_commonSimplex4 (VV *thee, VV *v0, VV *v1, VV *v2, SS *sm)
 Return a 3-simplex that is shared by 4 vertices, and which is different from the input simplex sm.
VVVV_commonVertex3 (VV *thee, VV *v0, VV *v1)
 the common vertex pointer
VVVV_commonVertex4 (VV *thee, VV *v0, VV *v1, VV *v2)
 the common vertex pointer

Detailed Description

VV class.


Typedef Documentation

typedef struct sVV VV

Declaration of the VV class as the VV structure.

Author:
Michael Holst


Function Documentation

void VV_addEdgeToRing ( VV thee,
EE eg 
)

Add an edge to an edge ring.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
eg Pointer to an edge

void VV_addSimplexToRing ( VV thee,
SS sm 
)

Add a simplex to a simplex ring.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
sm Pointer to a simplex

unsigned int VV_chart ( VV thee  ) 

Return the chart.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
the chart
Parameters:
thee Pointer to a vertex

unsigned int VV_class ( VV thee  ) 

Return the class.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
the class
Parameters:
thee Pointer to a vertex

EE* VV_commonEdge ( VV thee,
VV v0 
)

Return the common edge between two vertices.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
the common edge between two vertices.
Parameters:
thee Pointer to a vertex
v0 Pointer to a vertex

SS* VV_commonSimplex2 ( VV thee,
VV v0,
SS sm 
)

Return a 2-simplex that is shared by 2 vertices, and which is different from the input simplex sm.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
2-simplex that is shared by 2 vertices, and which is different from the input simplex sm.
Parameters:
thee Pointer to a vertex
v0 Pointer to a vertex
sm Pointer to a simplex

SS* VV_commonSimplex3 ( VV thee,
VV v0,
VV v1,
SS sm 
)

Return a 3-simplex that is shared by 3 vertices, and which is different from the input simplex sm.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
3-simplex that is shared by 3 vertices, and which is different from the input simplex sm.
Parameters:
thee Pointer to a vertex
v0 Pointer to a vertex
v1 Pointer to a vertex
sm Pointer to a smplex

SS* VV_commonSimplex4 ( VV thee,
VV v0,
VV v1,
VV v2,
SS sm 
)

Return a 3-simplex that is shared by 4 vertices, and which is different from the input simplex sm.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
3-simplex that is shared by 4 vertices, and which is different from the input simplex sm.
Parameters:
thee Pointer to a vertex
v0 Pointer to a vertex
v1 Pointer to a vertex
v2 Pointer to a vertex
sm Pointer to a simplex

VV* VV_commonVertex3 ( VV thee,
VV v0,
VV v1 
)

the common vertex pointer

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
Pointer to the common vertex
Parameters:
thee Pointer to a vertex
v0 Pointer to a vertex
v1 Pointer to a vertex

VV* VV_commonVertex4 ( VV thee,
VV v0,
VV v1,
VV v2 
)

the common vertex pointer

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
Pointer to the common vertex
Parameters:
thee Pointer to a vertex
v0 Pointer to a vertex
v1 Pointer to a vertex
v2 Pointer to a vertex

double VV_coord ( VV thee,
int  i 
)

Return the coordinate.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
the coordinate
Parameters:
thee Pointer to a vertex
i Index for a vertex in one simplex

VV* VV_ctor ( int  dim,
int  myid 
)

The vertex constructor.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
Pointer to a new allocated vertex
Parameters:
dim the dimension bits
myid the ID bits

unsigned int VV_dim ( VV thee  ) 

Return the dimension.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
the dimension
Parameters:
thee Pointer to a vertex

unsigned int VV_dimEE ( VV thee  ) 

Return the number of edges in a simplex.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
the number of edges in a simplex.
Parameters:
thee Pointer to a vertex

unsigned int VV_dimFF ( VV thee  ) 

Return the number of faces in a simplex.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
the number of faces in a simplex.
Parameters:
thee Pointer to a vertex

unsigned int VV_dimVV ( VV thee  ) 

Return the number of vertices in a simplex.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
the number of vertices in a simplex.
Parameters:
thee Pointer to a vertex

void VV_dtor ( VV **  thee  ) 

The vertex destructor.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex

int VV_edgeInRing ( VV thee,
EE eg 
)

Is an edge in the edge ring.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
Success enumeration
Parameters:
thee Pointer to a vertex
eg Pointer to an edge

EE* VV_firstEE ( VV thee  ) 

Set the first edge in an edge ring.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
Pointer to the first edge in an edge ring.
Parameters:
thee Pointer to a vertex

SS* VV_firstSS ( VV thee  ) 

Set the first simplex in a simplex ring.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
Pointer to the first simplex in a simplex ring.
Parameters:
thee Pointer to a vertex

unsigned int VV_id ( VV thee  ) 

Return the ID.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
the ID
Parameters:
thee Pointer to a vertex

void VV_init ( VV thee,
int  dim,
int  id 
)

Intialize a vertex.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
dim the dimension of the mesh
id the ID bits

EE* VV_parentEdge ( VV thee,
VV v0 
)

Return parent edge having one of two vertices as midpoint.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
parent edge having one of two vertices as midpoint.
Parameters:
thee Pointer to a vertex
v0 Pointer to a vertex

EE* VV_parentEE ( VV thee  ) 

the parent edge pointer.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
Pointer to the parent edge
Parameters:
thee Pointer to a vertex

unsigned int VV_reality ( VV thee  ) 

Return the reality.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
the reality
Parameters:
thee Pointer to a vertex

void VV_reinit ( VV thee  ) 

Re-intialize a vertex.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex

void VV_removeEdgeFromRing ( VV thee,
EE eg 
)

Remove an edge from an edge ring.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
eg Pointer to an edge

void VV_removeSimplexFromRing ( VV thee,
SS sm 
)

Remove a simplex from a simplex ring.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
sm Pointer to a simplex

void VV_setChart ( VV thee,
int  chart 
)

Set the chart.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
chart the chart bits

void VV_setClass ( VV thee,
int  type 
)

Set the class.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
type the class bits

void VV_setCoord ( VV thee,
int  i,
double  val 
)

Set the coordinate.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
i index of the coordinate
val the value of the coordinate

void VV_setDim ( VV thee,
int  dim 
)

Set the dimension.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
dim the dimension bits

void VV_setFirstEE ( VV thee,
EE eg 
)

Set the first edge in an edge ring.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
eg Pointer to an edge

void VV_setFirstSS ( VV thee,
SS sm 
)

Set the first simplex in a simplex ring.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
sm Pointer to a simplex

void VV_setId ( VV thee,
int  id 
)

Set the ID.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
id the ID bits

void VV_setParentEE ( VV thee,
EE eg 
)

Set the parent edge pointer.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
eg Pointer to an edge

void VV_setReality ( VV thee,
int  type 
)

Set the reality.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
type the reality bits

void VV_setType ( VV thee,
int  type 
)

Set the type.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
None
Parameters:
thee Pointer to a vertex
type the type bits

int VV_simplexInRing ( VV thee,
SS sm 
)

Is a simplex in a simplex ring.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
Success enumeration
Parameters:
thee Pointer to a vertex
sm Pointer to a simplex

unsigned int VV_type ( VV thee  ) 

Return the type.

Author:
Michael Holst
Note:
Class V: Inlineable methods (ves.c)
Returns:
the type
Parameters:
thee Pointer to a vertex


Generated on Mon Aug 9 11:13:45 2010 for MC by  doxygen 1.5.6