PIPS-NLP
Public Member Functions | Protected Attributes | List of all members
PetscSpGenMatrix Class Reference

#include <PetscSpGenMatrix.h>

Inheritance diagram for PetscSpGenMatrix:
GenMatrix DoubleMatrix IotrRefCount

Public Member Functions

PetscSparseStoragegetStorage ()
 
PetscSparseStoragestorage ()
 
 PetscSpGenMatrix (int m, int n, int nnz)
 
 PetscSpGenMatrix (Mat M)
 
virtual int isKindOf (int type)
 
virtual void atPutDense (int row, int col, double *A, int lda, int rowExtent, int colExtent)
 
virtual void fromGetDense (int row, int col, double *A, int lda, int rowExtent, int colExtent)
 
virtual void fromGetSpRow (int row, int col, double A[], int lenA, int jcolA[], int &nnz, int colExtent, int &info)
 
virtual void atPutSpRow (int row, double A[], int lenA, int jcolA[], int &info)
 
virtual void getSize (int &m, int &n)
 
virtual void atPutSubmatrix (int destRow, int destCol, DoubleMatrix &M, int srcRow, int srcCol, int rowExtent, int colExtent)
 
virtual void mult (double beta, OoqpVector &y, double alpha, OoqpVector &x)
 
virtual void transMult (double beta, OoqpVector &y, double alpha, OoqpVector &x)
 
virtual void getDiagonal (OoqpVector &vec)
 
virtual void setToDiagonal (OoqpVector &vec)
 
virtual void atPutDiagonal (int idiag, OoqpVector &v)
 
virtual void fromGetDiagonal (int idiag, OoqpVector &v)
 
virtual double abmaxnorm ()
 
virtual void writeToStream (ostream &out) const
 
virtual void randomize (double alpha, double beta, double *seed)
 
virtual void putSparseTriple (int irow[], int len, int jcol[], double A[], int &info)
 
virtual void SymmetricScale (OoqpVector &vec)
 
virtual void ColumnScale (OoqpVector &vec)
 
virtual void RowScale (OoqpVector &vec)
 
virtual void scalarMult (double num)
 
virtual ~PetscSpGenMatrix ()
 
virtual void copyMtxFromDouble (int copyLength, double *values)
 
- Public Member Functions inherited from GenMatrix
virtual void matTransDMultMat (OoqpVector &d, SymMatrix **res)=0
 
virtual void matTransDinvMultMat (OoqpVector &d, SymMatrix **res)=0
 
- Public Member Functions inherited from DoubleMatrix
 DoubleMatrix ()
 
virtual void fromAddDense (int row, int col, double *A, int lda, int rowExtent, int colExtent)
 
virtual void writeToStream (std::ostream &out) const =0
 
virtual void getSize (long long &m, long long &n)=0
 
virtual ~DoubleMatrix ()
 
virtual void setAdditiveDiagonal (OoqpVector &additiveDiag_)
 
virtual void copyDiagonalVal_From (int idiag, OoqpVector &x, bool firstCall, std::map< int, int > &ValIdxMap)
 
virtual void fromGetSpRow_WithRowStart (int row, int col, double A[], int lenA, int jcolA[], int &nnz, int colExtent, int &info, int &rowStart)
 
virtual void fromGetDense_withMap (int row, int col, double *A, int lda, int rowExtent, int colExtent, int const FirstCall, std::map< int, int > &ValIdxMap)
 
virtual double * getMatVal ()
 
virtual int * krowM ()
 
virtual int * jcolM ()
 
virtual double * M ()
 
- Public Member Functions inherited from IotrRefCount
int refs ()
 
 IotrRefCount ()
 

Protected Attributes

PetscSparseStorageHandle mStorage
 

Additional Inherited Members

- Static Public Member Functions inherited from IotrRefCount
static void release (IotrRefCount **obj)
 
static void addRef (IotrRefCount *const *obj)
 
- Static Public Attributes inherited from IotrRefCount
static int instances = 0
 
- Protected Member Functions inherited from IotrRefCount
virtual ~IotrRefCount ()
 

Constructor & Destructor Documentation

PetscSpGenMatrix::PetscSpGenMatrix ( int  m,
int  n,
int  nnz 
)
PetscSpGenMatrix::PetscSpGenMatrix ( Mat  M)
virtual PetscSpGenMatrix::~PetscSpGenMatrix ( )
inlinevirtual

Member Function Documentation

double PetscSpGenMatrix::abmaxnorm ( )
virtual

the magnitude of the element in this matrix with largest absolute value.

Implements DoubleMatrix.

void PetscSpGenMatrix::atPutDense ( int  row,
int  col,
double *  A,
int  lda,
int  rowExtent,
int  colExtent 
)
virtual

Set the value of some of the elements of this matrix.

See also
DoubleMatrix::fromGetDense

Implements GenMatrix.

void PetscSpGenMatrix::atPutDiagonal ( int  idiag,
OoqpVector x 
)
virtual

Set some of the diagonal elements of this matrix.

Parameters
idiagthe index of the first diagonal element to be modified.
xthe new values for the diagonal elements.

The length of x is the number of diagonal elements to be modified. Typically x will have length less than the length of the diagonal.

Implements DoubleMatrix.

void PetscSpGenMatrix::atPutSpRow ( int  col,
double  A[],
int  lenA,
int  jcolA[],
int &  info 
)
virtual

Put a sparse row into this matrix.

The meaning of the parmameters is the same as in fromGetSpRow.

See also
DoubleMatrix::fromGetSpRow

Implements GenMatrix.

void PetscSpGenMatrix::atPutSubmatrix ( int  destRow,
int  destCol,
DoubleMatrix M,
int  srcRow,
int  srcCol,
int  rowExtent,
int  colExtent 
)
virtual

Put a submatrix of M into this matrix.

Parameters
destRowThe top row of the submatrix of M is placed at destRow.
destColThe leftmost column of the submatrix of M is placed at destCol.
srcRowThe first row of the submatrix of M is srcRow.
srcColThe first column of the submatrix of M is srcCol.
rowExtentrowExtent rows are copied from M.
colExtentcolExtent columns are copied from M.

Implements GenMatrix.

void PetscSpGenMatrix::ColumnScale ( OoqpVector vec)
virtual

Implements DoubleMatrix.

void PetscSpGenMatrix::copyMtxFromDouble ( int  copyLength,
double *  values 
)
virtual

Reimplemented from DoubleMatrix.

void PetscSpGenMatrix::fromGetDense ( int  row,
int  col,
double *  A,
int  lda,
int  rowExtent,
int  colExtent 
)
virtual

Get the value of some of the elements of this matrix.

Parameters
rowstart reading the elements of this matrix from row number "row".
colstart reading the elements of this matrix from column number "col".
AAny array to hold the values from this matrix.
ldAthe leading dimension of A.
rowExtentget rowExtent rows from this matrix.
colExtentget colExtent columns from this matrix.

Implements DoubleMatrix.

void PetscSpGenMatrix::fromGetDiagonal ( int  idiag,
OoqpVector x 
)
virtual

Get some of the diagonal elements of this matrix.

Parameters
idiagthe index of the first diagonal element to be read.
xa vector to hold the diagonal elements

The length of x is the number of diagonal elements to be gotten. Typically x will have length less than the length of the diagonal.

Implements DoubleMatrix.

void PetscSpGenMatrix::fromGetSpRow ( int  row,
int  col,
double  A[],
int  lenA,
int  jcolA[],
int &  nnz,
int  colExtent,
int &  info 
)
virtual

Get one sparse row from this matrix.

Parameters
rowget row number "row"
colignore all elements of the row before column "col"
Astore the values of the sparse row in A
lenAthe length of A
jcolAan array of length lenA containing the column index of each element in the sparse row
colExtentignore all elements of the row that have column indices greater than or equal to col + colExtent
infoinfo is 0 if and only if the sparse row can fit into A.

Implements DoubleMatrix.

void PetscSpGenMatrix::getDiagonal ( OoqpVector vec)
virtual

Place the diagonal elements of this matrix in the vector vec

Implements DoubleMatrix.

void PetscSpGenMatrix::getSize ( int &  m,
int &  n 
)
virtual

Implements DoubleMatrix.

PetscSparseStorage* PetscSpGenMatrix::getStorage ( )
inline
int PetscSpGenMatrix::isKindOf ( int  matrixType)
virtual

True if this matrix identifies itself to be of type matrixType.

Implements DoubleMatrix.

void PetscSpGenMatrix::mult ( double  beta,
OoqpVector y,
double  alpha,
OoqpVector x 
)
virtual

y = beta * y + alpha * this * x

Implements DoubleMatrix.

void PetscSpGenMatrix::putSparseTriple ( int  irow[],
int  len,
int  jcol[],
double  A[],
int &  info 
)
virtual

Copy elements from sparse triple format into this matrix

Parameters
lenthe number of elements
irowan array containing the row number of the elements
jcolan array containing the column number of the elements
Aan array containing the values for the elements.
infoon return, info will be zero if and only if the insertion was successful.

Implements DoubleMatrix.

void PetscSpGenMatrix::randomize ( double  alpha,
double  beta,
double *  seed 
)
virtual

Fill this matrix with random elements.

Parameters
alphathe elements will be no smaller than alpha.
betathe elements will be no larger than beta.
seeda arbitrary number used to seed the random number generator.

Implements GenMatrix.

void PetscSpGenMatrix::RowScale ( OoqpVector vec)
virtual

Implements DoubleMatrix.

void PetscSpGenMatrix::scalarMult ( double  num)
virtual

Implements DoubleMatrix.

void PetscSpGenMatrix::setToDiagonal ( OoqpVector vec)
virtual

Set the matrix to the diagoanl matrix whose diagonal is vec

Implements DoubleMatrix.

PetscSparseStorage& PetscSpGenMatrix::storage ( )
inline
void PetscSpGenMatrix::SymmetricScale ( OoqpVector vec)
virtual

Get the number of rows and columns in the matrix

Parameters
mthe number of rows
nthe number of columns

Implements DoubleMatrix.

void PetscSpGenMatrix::transMult ( double  beta,
OoqpVector y,
double  alpha,
OoqpVector x 
)
virtual

y = beta * y + alpha * this^T * x

Implements DoubleMatrix.

void PetscSpGenMatrix::writeToStream ( ostream &  out) const
virtual

Member Data Documentation

PetscSparseStorageHandle PetscSpGenMatrix::mStorage
protected

The documentation for this class was generated from the following files: