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

#include <DenseGenMatrix.h>

Inheritance diagram for DenseGenMatrix:
GenMatrix DoubleMatrix IotrRefCount

Public Member Functions

 DenseGenMatrix (int size)
 
 DenseGenMatrix (int m, int n)
 
 DenseGenMatrix (double A[], int m, int n)
 
virtual int isKindOf (int matType)
 
virtual void getSize (long long &m, long long &n)
 
virtual void getSize (int &m, int &n)
 
virtual void atPutDense (int row, int col, double *A, int lda, int rowExtent, int colExtent)
 
virtual void atPutZeros (int row, int col, int rowExtent, int colExtent)
 
virtual void getDiagonal (OoqpVector &vec)
 
virtual void setToDiagonal (OoqpVector &vec)
 
virtual void atPutSubmatrix (int destRow, int destCol, DoubleMatrix &M, int srcRow, int srcCol, int rowExtent, int colExtent)
 
virtual void atPutSpRow (int row, double A[], int lenA, int jcolA[], int &info)
 
virtual void putSparseTriple (int irow[], int len, int jcol[], double A[], int &info)
 
virtual void mult (double beta, OoqpVector &y, double alpha, OoqpVector &x)
 
virtual void mult (double beta, double y[], int incy, double alpha, double x[], int incx)
 
virtual void transMult (double beta, OoqpVector &y, double alpha, OoqpVector &x)
 
virtual void transMult (double beta, double y[], int incy, double alpha, double x[], int incx)
 
virtual void matTransDMultMat (OoqpVector &d, SymMatrix **res)
 
virtual void matTransDinvMultMat (OoqpVector &d, SymMatrix **res)
 
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 rowExtent, int &info)
 
virtual void ColumnScale (OoqpVector &vec)
 
virtual void RowScale (OoqpVector &vec)
 
virtual void SymmetricScale (OoqpVector &vec)
 
virtual void scalarMult (double num)
 
virtual double abmaxnorm ()
 
virtual void writeToStream (std::ostream &out) const
 
virtual void randomize (double alpha, double beta, double *seed)
 
virtual void atPutDiagonal (int idiag, OoqpVector &v)
 
virtual void fromGetDiagonal (int idiag, OoqpVector &v)
 
virtual void getRow (int rowIndex, OoqpVector &v_in)
 
double * operator[] (int index)
 
const double * operator[] (int index) const
 
double * elements ()
 
double ** Mat ()
 
DenseStoragegetStorageRef ()
 
DenseStoragegetStorage ()
 
virtual void matMult (double alpha, DenseGenMatrix &A, int transA, DenseGenMatrix &B, int transB, double beta)
 
- Public Member Functions inherited from DoubleMatrix
 DoubleMatrix ()
 
virtual void fromAddDense (int row, int col, double *A, int lda, int rowExtent, int colExtent)
 
virtual ~DoubleMatrix ()
 
virtual void copyMtxFromDouble (int copyLength, double *values)
 
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 ()
 

Public Attributes

DenseStorageHandle 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 ()
 

Detailed Description

A class of dense, non-symmetric, possibly non-square, matrices.

Constructor & Destructor Documentation

DenseGenMatrix::DenseGenMatrix ( int  size)
DenseGenMatrix::DenseGenMatrix ( int  m,
int  n 
)
DenseGenMatrix::DenseGenMatrix ( double  A[],
int  m,
int  n 
)

Member Function Documentation

double DenseGenMatrix::abmaxnorm ( )
virtual

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

Implements DoubleMatrix.

void DenseGenMatrix::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 DenseGenMatrix::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 DenseGenMatrix::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 DenseGenMatrix::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 DenseGenMatrix::atPutZeros ( int  row,
int  col,
int  rowExtent,
int  colExtent 
)
virtual

Fill a region of this matrix with zeros.

The region starts at (row, col) and extends rowExtent rows and colExtent columns.

void DenseGenMatrix::ColumnScale ( OoqpVector vec)
virtual

Implements DoubleMatrix.

double* DenseGenMatrix::elements ( )
inline

Return a pointer to the first element in the matrix

void DenseGenMatrix::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 DenseGenMatrix::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 DenseGenMatrix::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 DenseGenMatrix::getDiagonal ( OoqpVector vec)
virtual

Place the diagonal elements of this matrix in the vector vec

Implements DoubleMatrix.

void DenseGenMatrix::getRow ( int  rowIndex,
OoqpVector v_in 
)
virtual

Get a row of this matrix.

void DenseGenMatrix::getSize ( long long &  m,
long long &  n 
)
virtual

Implements DoubleMatrix.

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

Implements DoubleMatrix.

DenseStorage* DenseGenMatrix::getStorage ( )
inline
DenseStorage& DenseGenMatrix::getStorageRef ( )
inline
int DenseGenMatrix::isKindOf ( int  matrixType)
virtual

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

Implements DoubleMatrix.

double** DenseGenMatrix::Mat ( )
inline

Return mMat, an

void DenseGenMatrix::matMult ( double  alpha,
DenseGenMatrix A,
int  transA,
DenseGenMatrix B,
int  transB,
double  beta 
)
virtual

MatMat product

this = alpha* op(A) * op(B) + beta*this

op(...) specifies whether to use the matrix or its transpose

void DenseGenMatrix::matTransDinvMultMat ( OoqpVector d,
SymMatrix **  res 
)
virtual

C = this^T * inv(D) * this where D=diag(d) is a diagonal matrix.

Implements GenMatrix.

void DenseGenMatrix::matTransDMultMat ( OoqpVector d,
SymMatrix **  res 
)
virtual

C = this^T * D * this where D=diag(d) is a diagonal matrix.

Implements GenMatrix.

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

y = beta * y + alpha * this * x

Implements DoubleMatrix.

void DenseGenMatrix::mult ( double  beta,
double  y[],
int  incy,
double  alpha,
double  x[],
int  incx 
)
virtual
double* DenseGenMatrix::operator[] ( int  index)
inline
const double* DenseGenMatrix::operator[] ( int  index) const
inline
void DenseGenMatrix::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 DenseGenMatrix::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 DenseGenMatrix::RowScale ( OoqpVector vec)
virtual

Implements DoubleMatrix.

void DenseGenMatrix::scalarMult ( double  num)
virtual

Implements DoubleMatrix.

void DenseGenMatrix::setToDiagonal ( OoqpVector vec)
virtual

Set the matrix to the diagoanl matrix whose diagonal is vec

Implements DoubleMatrix.

void DenseGenMatrix::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 DenseGenMatrix::transMult ( double  beta,
OoqpVector y,
double  alpha,
OoqpVector x 
)
virtual

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

Implements DoubleMatrix.

void DenseGenMatrix::transMult ( double  beta,
double  y[],
int  incy,
double  alpha,
double  x[],
int  incx 
)
virtual
void DenseGenMatrix::writeToStream ( std::ostream &  out) const
virtual

Write this element to a C++ stream

Implements DoubleMatrix.

Member Data Documentation

DenseStorageHandle DenseGenMatrix::mStorage

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