MFNSpace

Collaboration diagram for MFNSpace:


Modules

 IMFExpansionNSpace
 IMFNSpace
 MFLOCANSpace

Classes

class  MFNSpace
 An embedding space (a metric space), which provides inner products and distances. More...

Functions

MFNSpace MFCreateNSpace (int n, MFErrorHandler e)
 Creates a Euclidean n-space.
MFNSpace MFCreateTPBVPNSpace (int nx, int nu, int np, MFErrorHandler e)
 Creates a space for the solutions of an MFTPBVP (two point boundary value problem).
double MFNSpaceInner (MFNSpace space, MFNVector a, MFNVector b, MFErrorHandler e)
 Calculates the inner product of two vectors using the inner product of the space.
double MFNSpaceDistance (MFNSpace space, MFNVector a, MFNVector b, MFErrorHandler e)
 Calculates the distance between two vectors using the metric of the space.
double MFNSpaceTangentDistance (MFNSpace space, MFNKMatrix A, MFNKMatrix B, MFErrorHandler e)
 Calculates the "distance" between two "Tangent Spaces". Really just a measure of how different the span of the bases are.
void MFNSpaceDirection (MFNSpace space, MFNVector a, MFNVector b, MFNVector c, MFErrorHandler e)
 Calculates the tangent to the geodesic between two points.
void MFNSpaceAdd (MFNSpace space, MFNVector a, MFNVector b, MFNVector c, MFErrorHandler e)
 Calculates the sum of two vectors in the embedding space.
void MFNSpaceScale (MFNSpace space, double scalar, MFNVector a, MFNVector b, MFErrorHandler e)
 Calculates the product of a scalar and a vector in the embedding space.
void * MFNSpaceGetData (MFNSpace space, MFErrorHandler e)
 Returns the internal representation of an embedding space. Be careful!
char * MFNSpaceGetId (MFNSpace space, MFErrorHandler e)
 Query the type an embedding space. Don't free the string, and don't change it.
void MFRefNSpace (MFNSpace n-space, MFErrorHandler e)
 Adds a reference to the n-space.
void MFFreeNSpace (MFNSpace space, MFErrorHandler e)
 Frees a reference to the n-space, and deletes the n-space if there are no references left.
void MFWriteNSpace (FILE *fid, MFNSpace space, MFErrorHandler e)
 Writes a n-space to a file.
MFNSpace MFReadNSpace (FILE *fid, MFAtlas A, MFErrorHandler e)
 Reads a n-space from a file.

Function Documentation

MFNSpace MFCreateNSpace (  int  n,
MFErrorHandler  e
) 
 

Creates a Euclidean n-space.

Parameters:
n The dimension of the space.
e A place to return errors.
Returns:
A new n-space.

MFNSpace MFCreateTPBVPNSpace (  int  nx,
int  nu,
int  np,
MFErrorHandler  e
) 
 

Creates a space for the solutions of an MFTPBVP (two point boundary value problem).

Parameters:
nx The number of mesh intervals.
nu The number of functions defined on the mesh.
np The number of scalar parameters.
e A place to return errors.
Returns:
A new n-space.

void MFFreeNSpace (  MFNSpace  space,
MFErrorHandler  e
) 
 

Frees a reference to the n-space, and deletes the n-space if there are no references left.

Parameters:
space The n-space being unreferenced.
e A place to return errors.
See also:
ReferenceCounting MFRefNSpace

void MFNSpaceAdd (  MFNSpace  space,
MFNVector  a,
MFNVector  b,
MFNVector  c,
MFErrorHandler  e
) 
 

Calculates the sum of two vectors in the embedding space.

Parameters:
space The space.
a The first n-vector.
b The second n-vector.
c The sum a+b.
e A place to return errors.

Definition at line 79 of file MFNSpace.h.

void MFNSpaceDirection (  MFNSpace  space,
MFNVector  a,
MFNVector  b,
MFNVector  c,
MFErrorHandler  e
) 
 

Calculates the tangent to the geodesic between two points.

Parameters:
space The space.
a The origin.
b The destination.
c The direction (infinitesimal) from a to b..
e A place to return errors.

Definition at line 68 of file MFNSpace.h.

double MFNSpaceDistance (  MFNSpace  space,
MFNVector  a,
MFNVector  b,
MFErrorHandler  e
) 
 

Calculates the distance between two vectors using the metric of the space.

Parameters:
space The space.
a The origin.
b The destination.
e A place to return errors.
Returns:
dist(a,b).

Definition at line 45 of file MFNSpace.h.

void * MFNSpaceGetData (  MFNSpace  space,
MFErrorHandler  e
) 
 

Returns the internal representation of an embedding space. Be careful!

Parameters:
space The space.
e A place to return errors.
Returns:
A pointer to the data block.

Definition at line 101 of file MFNSpace.h.

char * MFNSpaceGetId (  MFNSpace  space,
MFErrorHandler  e
) 
 

Query the type an embedding space. Don't free the string, and don't change it.

Parameters:
space The space.
e A place to return errors.
Returns:
The character string with the ID.

Definition at line 110 of file MFNSpace.h.

double MFNSpaceInner (  MFNSpace  space,
MFNVector  a,
MFNVector  b,
MFErrorHandler  e
) 
 

Calculates the inner product of two vectors using the inner product of the space.

Parameters:
space The space.
a The first n-vector.
b The second n-vector.
e A place to return errors.
Returns:
<a,b>.

Definition at line 34 of file MFNSpace.h.

void MFNSpaceScale (  MFNSpace  space,
double  scalar,
MFNVector  a,
MFNVector  b,
MFErrorHandler  e
) 
 

Calculates the product of a scalar and a vector in the embedding space.

Parameters:
space The space.
scalar The scalar.
a The n-vector.
b The product scalar*a.
e A place to return errors.

Definition at line 90 of file MFNSpace.h.

double MFNSpaceTangentDistance (  MFNSpace  space,
MFNKMatrix  A,
MFNKMatrix  B,
MFErrorHandler  e
) 
 

Calculates the "distance" between two "Tangent Spaces". Really just a measure of how different the span of the bases are.

Parameters:
space The space.
A The origin.
B The destination.
e A place to return errors.
Returns:
dist(A,B).

Definition at line 56 of file MFNSpace.h.

MFNSpace MFReadNSpace (  FILE *  fid,
MFAtlas  A,
MFErrorHandler  e
) 
 

Reads a n-space from a file.

Parameters:
fid The file to write to.
A The Atlas for the n-space.
e A place to return errors.
Returns:
n-space The n-space.

void MFRefNSpace (  MFNSpace n-  space,
MFErrorHandler  e
) 
 

Adds a reference to the n-space.

Parameters:
space The n-space being referenced.
e A place to return errors.
See also:
ReferenceCounting MFFreeNSpace

Definition at line 119 of file MFNSpace.h.

void MFWriteNSpace (  FILE *  fid,
MFNSpace  space,
MFErrorHandler  e
) 
 

Writes a n-space to a file.

Parameters:
fid The file to write to.
space The n-space being queried.
e A place to return errors.

Generated on Tue Jan 30 13:40:18 2007 for multifario by  doxygen 1.4.6