MFNVector

Collaboration diagram for MFNVector:


Modules

 IMFExpansionNVector
 MFLOCANVector
 MFDenseNVector
 MFWrappedNVector

Classes

class  MFNVector
 A vector that lies in the embedding space of a matrix. More...

Functions

MFNVector MFCloneNVector (MFNVector u, MFErrorHandler e)
 Creates a copy of an MFNVector. The copy is the same type and has the same coordinates. Changing the coordinates of the copy cwwill not change the original's coordinates.
void MFRefNVector (MFNVector u, MFErrorHandler e)
 Adds a reference to the MFNVector.
void MFFreeNVector (MFNVector u, MFErrorHandler e)
 Removes a reference to the MFNVector and if the number of references becomes zero deletes the MFNVector.
int MFNV_NC (MFNVector u, MFErrorHandler e)
 Returns the dimension of a MFNVector.
double MFNV_C (MFNVector u, int i, MFErrorHandler e)
 Returns the value of the ith coordinate of a MFNVector. This is inefficient, check the type and get the data.
void * MFNVectorGetData (MFNVector u, MFErrorHandler e)
 Returns a pointer to the internal data of a vector. The user needs to know how it is stored.
void MFNVSetC (MFNVector u, int i, double c, MFErrorHandler e)
 Changes the value of the ith coordinate of a MFNVector. This is inefficient, check the type and get the data.
void MFNVAdd (MFNVector a, MFNVector b, MFNVector c, MFErrorHandler e)
 Adds a and b coordinatewise and puts the result in c. It is better to use the NSpace.
void MFNVDiff (MFNVector a, MFNVector b, MFNVector c, MFErrorHandler e)
 Takes the difference of a and b coordinatewise and puts the result in c. It is better to use the NSpace.
void MFWriteNVector (FILE *fid, MFNVector u, MFErrorHandler e)
 Writes a vector to a file.
MFNVector MFReadNVector (FILE *fid, MFErrorHandler e)
 Read a vector from a file.
char * MFNVGetId (MFNVector u, MFErrorHandler e)
 Get the type of a vector. This is a string which is set when the vector was created. Don't delete it!

Function Documentation

MFNVector MFCloneNVector MFNVector  u,
MFErrorHandler  e
 

Creates a copy of an MFNVector. The copy is the same type and has the same coordinates. Changing the coordinates of the copy cwwill not change the original's coordinates.

Parameters:
u An MFNVector.
e A place to return errors.
Returns:
A clone of u.

void MFFreeNVector MFNVector  u,
MFErrorHandler  e
 

Removes a reference to the MFNVector and if the number of references becomes zero deletes the MFNVector.

Parameters:
u The MFNVector to free.
e A place to return errors.

double MFNV_C MFNVector  u,
int  i,
MFErrorHandler  e
 

Returns the value of the ith coordinate of a MFNVector. This is inefficient, check the type and get the data.

Parameters:
u The MFNVector.
i The coordinate requested.
e A place to return errors.
Returns:
The coordinate value.

int MFNV_NC MFNVector  u,
MFErrorHandler  e
 

Returns the dimension of a MFNVector.

Parameters:
u The MFNVector.
e A place to return errors.
Returns:
The dimension of u.

void MFNVAdd MFNVector  a,
MFNVector  b,
MFNVector  c,
MFErrorHandler  e
 

Adds a and b coordinatewise and puts the result in c. It is better to use the NSpace.

Parameters:
a The first vector.
b The first vector.
c a+b
e A place to return errors.

void MFNVDiff MFNVector  a,
MFNVector  b,
MFNVector  c,
MFErrorHandler  e
 

Takes the difference of a and b coordinatewise and puts the result in c. It is better to use the NSpace.

Parameters:
a The first vector.
b The first vector.
c a-b
e A place to return errors.

void * MFNVectorGetData MFNVector  u,
MFErrorHandler  e
 

Returns a pointer to the internal data of a vector. The user needs to know how it is stored.

Parameters:
u The MFNVector.
e A place to return errors.
Returns:
A pointer to the data.

char * MFNVGetId MFNVector  u,
MFErrorHandler  e
 

Get the type of a vector. This is a string which is set when the vector was created. Don't delete it!

Parameters:
u The vector.
e A place to return errors.
Returns:
The type.

void MFNVSetC MFNVector  u,
int  i,
double  c,
MFErrorHandler  e
 

Changes the value of the ith coordinate of a MFNVector. This is inefficient, check the type and get the data.

Parameters:
u The MFNVector.
i The coordinate to be changed.
c The new coordinate value.
e A place to return errors.

void MFReadNVector FILE *  fid,
MFErrorHandler  e
 

Read a vector from a file.

Parameters:
fid The file.
e A place to return errors.
Returns:
The vector.

void MFRefNVector MFNVector  u,
MFErrorHandler  e
 

Adds a reference to the MFNVector.

Parameters:
u The MFNVector to reference.
e A place to return errors.

void MFWriteNVector FILE *  fid,
MFNVector  u,
MFErrorHandler  e
 

Writes a vector to a file.

Parameters:
fid The file.
u The vector.
e A place to return errors.


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