sciMatrix.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	sciMatrix
Functions
sciMatrix *	emptyMatrix (void)
sciMatrix *	newMatrix (int nbRow, int nbCol)
sciMatrix *	newCompleteMatrix (void **dataMat, int nbRow, int nbCol)
void	deleteMatrix (sciMatrix *mat)
void	desallocateMatrix (sciMatrix *mat)
void *	getMatElement (const sciMatrix *mat, int row, int col)
int	getMatNbRow (const sciMatrix *mat)
int	getMatNbCol (const sciMatrix *mat)
void **	getMatData (const sciMatrix *mat)
void	setMatElement (sciMatrix *mat, int row, int col, void *newValue)
void	changeMatElement (sciMatrix *mat, int row, int col, void *newValue)
void	copyMatElement (sciMatrix *mat, int row, int col, const void *copyValue, int valueSize)

---

Function Documentation

void changeMatElement	(	sciMatrix *	mat,
		int	row,
		int	col,
		void *	newValue
	)

desalocate the (row,col) element and put a new one.

Parameters:

newValue

the new value which will be inserted directly in the matrix (no copy).

Definition at line 96 of file sciMatrix.c.

References FREE, mat, and NULL.

Referenced by copyMatElement().

{
  if ( mat->data[row + col * mat->nbRow] != NULL )
  {
    FREE( mat->data[row + col * mat->nbRow] ) ;
  }
  mat->data[row + col * mat->nbRow] = newValue ;
}

Here is the caller graph for this function:

void copyMatElement	(	sciMatrix *	mat,
		int	row,
		int	col,
		const void *	copyValue,
		int	valueSize
	)

desalocate the (row,col) current element (i,j) and copy the new one. The size of the element must be given in order to allocate memory.

Parameters:

	copyValue	copied value.
	valueSize	size of the data inserted in the matrix (ex: sizeof(double) ).

Definition at line 105 of file sciMatrix.c.

References changeMatElement(), MALLOC, mat, and memcpy().

Referenced by copyVect2dMatElement(), and copyVect2iMatElement().

{
  /* copy the value */
  void * newValue = MALLOC( valueSize ) ;
  memcpy( newValue, copyValue, valueSize ) ;

  /* change the current one */
  changeMatElement( mat, row, col, newValue ) ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void deleteMatrix

(

sciMatrix *

mat

)

delete the structure and data

Definition at line 59 of file sciMatrix.c.

References FREE, i, mat, and NULL.

Referenced by ConstructLegend(), ConstructText(), ConstructTitle(), deallocateText(), DestroyLegend(), DestroyText(), DestroyTitle(), DestroyUimenu(), drawTextEntity(), get_tics_labels_property(), sciSetStrings(), and sciSetText().

{
  int i ;
  for ( i = 0 ; i < mat->nbRow * mat->nbCol ; i++ )
  {
    FREE( mat->data[i] ) ;
    mat->data[i] = NULL ;
  }
  FREE( mat->data ) ;
  mat->data = NULL ;

  mat->nbCol = 0 ;
  mat->nbRow = 0 ;

  FREE( mat ) ;
}

Here is the caller graph for this function:

void desallocateMatrix

(

sciMatrix *

mat

)

delete only the structure, not the data (use with caution).

Definition at line 76 of file sciMatrix.c.

References FREE, mat, and NULL.

Referenced by getStringBox().

{
  mat->nbCol = 0 ;
  mat->nbRow = 0 ;
  mat->data  = NULL ;
  FREE( mat ) ;
}

Here is the caller graph for this function:

sciMatrix* emptyMatrix

(

void

)

allocate a matrix with no elements (nbrow = nbcol = 0)

Definition at line 16 of file sciMatrix.c.

References sciMatrix::data, MALLOC, sciMatrix::nbCol, sciMatrix::nbRow, and NULL.

Referenced by newCompleteMatrix(), and newMatrix().

{
  sciMatrix * newMat ;
  newMat = MALLOC( sizeof(sciMatrix) ) ;
  newMat->data  = NULL ;
  newMat->nbCol = 0    ;
  newMat->nbRow = 0    ;
  
  return newMat ;
}

Here is the caller graph for this function:

void** getMatData

(

const sciMatrix *

mat

)

get the pointer on the array of data. May be used for faster access to the data.

Definition at line 123 of file sciMatrix.c.

References mat.

Referenced by getStrMatData().

{ return mat->data ; }

Here is the caller graph for this function:

void* getMatElement	(	const sciMatrix *	mat,
		int	row,
		int	col
	)

retrieve the element (row,col) of the matrix.

Definition at line 84 of file sciMatrix.c.

References mat.

Referenced by getStrMatElement(), getVect2dMatElement(), and getVect2iMatElement().

{
  /* the matrix is stored by column like in scilab */
  
  return mat->data[row + col * mat->nbRow] ;
}

Here is the caller graph for this function:

int getMatNbCol

(

const sciMatrix *

mat

)

Definition at line 121 of file sciMatrix.c.

References mat.

Referenced by computeSuitableFont(), drawStringsInPosition(), getStringsRect(), and sciGetTextSize().

{ return mat->nbCol ; }

Here is the caller graph for this function:

int getMatNbRow

(

const sciMatrix *

mat

)

Definition at line 119 of file sciMatrix.c.

References mat.

Referenced by computeSuitableFont(), drawStringsInPosition(), getStringsRect(), and sciGetTextSize().

{ return mat->nbRow ; }

Here is the caller graph for this function:

sciMatrix* newCompleteMatrix	(	void **	dataMat,
		int	nbRow,
		int	nbCol
	)

create a nbRow x nbCol matrix which data are dataMat (directly, no copy).

Definition at line 47 of file sciMatrix.c.

References sciMatrix::data, emptyMatrix(), sciMatrix::nbCol, and sciMatrix::nbRow.

Referenced by getStringBox().

{
  /* create the matrix */
  sciMatrix * newMat = emptyMatrix() ;
  
  newMat->data  = dataMat ;
  newMat->nbRow = nbRow   ;
  newMat->nbCol = nbCol   ;
  
  return newMat ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sciMatrix* newMatrix	(	int	nbRow,
		int	nbCol
	)

create a nbRow x nbCol matrix of NULL pointers.

Definition at line 27 of file sciMatrix.c.

References sciMatrix::data, emptyMatrix(), i, MALLOC, sciMatrix::nbCol, sciMatrix::nbRow, and NULL.

Referenced by computeDefaultTicsLabels(), drawTextEntity(), and newFullStringMatrix().

{
  int i ;
  /* create the matrix */
  sciMatrix * newMat = emptyMatrix() ;
  
  /* allocate the data */
  newMat->data  = MALLOC( (nbRow * nbCol)*sizeof(void *) ) ;
  newMat->nbRow = nbRow ;
  newMat->nbCol = nbCol ;

  /* initialize to NULL */
  for ( i = 0 ; i < nbRow * nbCol ; i++ )
  {
    newMat->data[i] = NULL ;
  }

  return newMat ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void setMatElement	(	sciMatrix *	mat,
		int	row,
		int	col,
		void *	newValue
	)

set an element of the matrix to a new value but does not desalocate the previous if one exists.

Parameters:

newValue

the new value which will be inserted directly in the matrix (no copy).

Definition at line 91 of file sciMatrix.c.

References mat.

{
  mat->data[row + col * mat->nbRow] = newValue ;
}

---