Go to the documentation of this file.
6 #ifndef CoinPackedMatrix_H
7 #define CoinPackedMatrix_H
170 #ifndef COIN_FAST_CODE
172 throw CoinError(
"bad index",
"vectorFirst",
"CoinPackedMatrix");
180 #ifndef COIN_FAST_CODE
182 throw CoinError(
"bad index",
"vectorLast",
"CoinPackedMatrix");
189 #ifndef COIN_FAST_CODE
191 throw CoinError(
"bad index",
"vectorSize",
"CoinPackedMatrix");
195 #ifndef CLP_NO_VECTOR
199 #ifndef COIN_FAST_CODE
201 throw CoinError(
"bad index",
"vector",
"CoinPackedMatrix");
239 #ifndef CLP_NO_VECTOR
255 const int *vecind,
const double *vecelem);
256 #ifndef CLP_NO_VECTOR
273 const double *element,
int numberRows = -1);
274 #ifndef CLP_NO_VECTOR
290 const int *vecind,
const double *vecelem);
291 #ifndef CLP_NO_VECTOR
308 const double *element,
int numberColumns = -1);
322 void deleteCols(
const int numDel,
const int *indDel);
324 void deleteRows(
const int numDel,
const int *indDel);
330 const int numReplace,
const double *newElements);
336 bool keepZero =
false);
376 const int numMajor,
const int *indMajor);
381 const int numMajor,
const int *indMajor);
387 const int numMajor,
const int * indMajor,
388 const int numMinor,
const int * indMinor);
397 void copyOf(
const bool colordered,
398 const int minor,
const int major,
const CoinBigIndex numels,
399 const double *elem,
const int *ind,
401 const double extraMajor = 0.0,
const double extraGap = 0.0);
425 const int minor,
const int major,
427 double *&elem,
int *&ind,
429 const int maxmajor = -1,
const CoinBigIndex maxsize = -1);
465 void times(
const double *x,
double *y)
const;
466 #ifndef CLP_NO_VECTOR
475 #ifndef CLP_NO_VECTOR
521 void dumpMatrix(
const char *fname = NULL)
const;
537 #ifndef CLP_NO_VECTOR
543 const double *vecelem);
544 #ifndef CLP_NO_VECTOR
554 const double *vecelem);
555 #ifndef CLP_NO_VECTOR
574 const double *element);
629 void timesMajor(
const double *x,
double *y)
const;
630 #ifndef CLP_NO_VECTOR
640 void timesMinor(
const double *x,
double *y)
const;
641 #ifndef CLP_NO_VECTOR
653 #ifndef CLP_NO_VECTOR
661 template <
class FloatEqual >
764 const double extraMajor,
const double extraGap);
767 const int minor,
const int major,
const CoinBigIndex numels,
768 const double *elem,
const int *ind,
770 const double extraMajor,
const double extraGap);
773 const int minor,
const int major,
const CoinBigIndex numels,
774 const double *elem,
const int *ind,
788 const int *rowIndices,
789 const int *colIndices,
790 const double *elements,
811 int extraForMajor,
int extraElements,
817 int numberRows,
const int *whichRows,
818 int numberColumns,
const int *whichColumns);
847 int verifyMtx(
int verbosity = 1,
bool zeroesAreError =
false)
const;
854 const int minor,
const int major,
const CoinBigIndex numels,
855 const double *elem,
const int *ind,
857 const double extraMajor = 0.0,
const double extraGap = 0.0);
860 const int minor,
const int major,
861 const double *elem,
const int *ind,
864 const int minor,
const int major,
const CoinBigIndex numels,
865 const double *elem,
const int *ind,
881 const double *element,
int numberOther = -1);
893 const double *element,
int numberOther = -1);
void copyReuseArrays(const CoinPackedMatrix &rhs)
Copy method.
CoinBigIndex size_
the number of nonzero entries
double * element_
List of nonzero element values.
void rightAppendPackedMatrix(const CoinPackedMatrix &matrix)
Append the argument to the "right" of the current matrix.
bool colOrdered_
A flag indicating whether the matrix is column or row major ordered.
void setExtraGap(const double newGap)
Set the extra gap to be allocated to the specified value.
void reserve(const int newMaxMajorDim, const CoinBigIndex newMaxSize, bool create=false)
Reserve sufficient space for appending major-ordered vectors.
int getVectorSize(const int i) const
The length of i'th vector.
void submatrixOfWithDuplicates(const CoinPackedMatrix &matrix, const int numMajor, const int *indMajor)
Extract a submatrix from matrix.
void setExtraMajor(const double newMajor)
Set the extra major to be allocated to the specified value.
void modifyCoefficient(int row, int column, double newElement, bool keepZero=false)
Modify one element of packed matrix.
int majorDim_
number of vectors in matrix
void appendMinorFast(const int number, const CoinBigIndex *starts, const int *index, const double *element)
Append a set of rows (columns) to the end of a column (row) ordered matrix.
CoinBigIndex * start_
Starting positions of major-dimension vectors.
void majorAppendSameOrdered(const CoinPackedMatrix &matrix)
Append the columns of the argument to the right end of this matrix.
void appendRow(const CoinPackedVectorBase &vec)
Append a row to the end of the matrix.
void nullLengthArray()
NULLify length array.
void gutsOfCopyOfNoGaps(const bool colordered, const int minor, const int major, const double *elem, const int *ind, const CoinBigIndex *start)
When no gaps we can do faster.
CoinBigIndex maxSize_
max space allocated for entries
int * index_
List of nonzero element minor-dimension indices.
CoinBigIndex getNumElements() const
Number of entries in the packed matrix.
void nullIndexArray()
NULLify index array.
void transpose()
Transpose the matrix.
int * countOrthoLength() const
Count the number of entries in every minor-dimension vector and return an array containing these leng...
int getNumRows() const
Number of rows.
void resizeForAddingMajorVectors(const int numVec, const int *lengthVec)
int minorDim_
size of other dimension
const double * getElements() const
A vector containing the elements in the packed matrix.
int * getMutableVectorLengths() const
The lengths of the major-dimension vectors.
void dumpMatrix(const char *fname=NULL) const
Dump the matrix on stdout.
void submatrixOf(const CoinPackedMatrix &matrix, const int numMajor, const int *indMajor)
Extract a submatrix from matrix.
CoinPackedMatrix & operator=(const CoinPackedMatrix &rhs)
Assignment operator.
double extraMajor_
his much times more space should be allocated for major-dimension vectors when the matrix is resized.
CoinBigIndex * getMutableVectorStarts() const
The positions where the major-dimension vectors start in element_ and index_.
void nullStartArray()
NULLify start array.
int * getMutableIndices() const
A vector containing the minor indices of the elements in the packed matrix.
double getCoefficient(int row, int column) const
Return one element of packed matrix.
CoinBigIndex getLastStart() const
int getSizeVectorStarts() const
The size of the vectorStarts array.
double getExtraMajor() const
Return the current setting of the extra major.
void setDimensions(int numrows, int numcols)
Set the dimensions of the matrix.
void reverseOrderedCopyOf(const CoinPackedMatrix &rhs)
Make a reverse-ordered copy.
void clear()
Clear the data, but do not free any arrays.
void transposeTimes(const double *x, double *y) const
Return x * A in y.
int maxMajorDim_
max space allocated for major-dimension
CoinBigIndex getVectorLast(const int i) const
The position of the last element (well, one entry past the last) in the i'th major-dimension vector.
void deleteMinorVectors(const int numDel, const int *indDel)
Delete the minor-dimension vectors whose indices are listed in indDel.
void CoinPackedMatrixUnitTest()
Test the methods in the CoinPackedMatrix class.
void printMatrixElement(const int row_val, const int col_val) const
Print a single matrix element.
void minorAppendSameOrdered(const CoinPackedMatrix &matrix)
Append the columns of the argument to the bottom end of this matrix.
const CoinBigIndex * getVectorStarts() const
The positions where the major-dimension vectors start in elements and indices.
double * getMutableElements() const
A vector containing the elements in the packed matrix.
const int * getIndices() const
A vector containing the minor indices of the elements in the packed matrix.
CoinBigIndex eliminateDuplicates(double threshold)
Eliminate all duplicate AND small elements in matrix The column starts are not affected.
virtual ~CoinPackedMatrix()
Destructor.
void setNumElements(CoinBigIndex value)
Change the size of the bulk store after modifying - be careful.
CoinBigIndex getVectorFirst(const int i) const
The position of the first element in the i'th major-dimension vector.
const int * getVectorLengths() const
The lengths of the major-dimension vectors.
void appendMinorVectors(const int numvecs, const CoinPackedVectorBase *const *vecs)
Append several minor-dimension vectors to the end of the matrix.
bool isEquivalent2(const CoinPackedMatrix &rhs) const
Test for equivalence and report differences.
const CoinShallowPackedVector getVector(int i) const
Return the i'th vector in matrix.
CoinBigIndex compress(double threshold)
Eliminate all elements in matrix whose absolute value is less than threshold.
int getSizeVectorLengths() const
The size of the vectorLengths array.
void minorAppendOrthoOrdered(const CoinPackedMatrix &matrix)
Append the rows of the argument to the bottom end of this matrix.
void deleteRows(const int numDel, const int *indDel)
Delete the rows whose indices are listed in indDel.
void appendCol(const CoinPackedVectorBase &vec)
Append a column to the end of the matrix.
void times(const double *x, double *y) const
Return A * x in y.
bool hasGaps() const
Whether the packed matrix has gaps or not.
Abstract base class for various sparse vectors.
void bottomAppendPackedMatrix(const CoinPackedMatrix &matrix)
Append the argument to the "bottom" of the current matrix.
void setMajorDim(int value)
Set major dimension.
int getMaxMajorDim() const
Current maximum for major dimension.
int getMinorDim() const
Minor dimension.
CoinBigIndex cleanMatrix(double threshold=1.0e-20)
Really clean up matrix.
Sparse Matrix Base Class.
int getMajorDim() const
Major dimension.
void orderMatrix()
Sort all columns so indices are increasing.in each column.
int * length_
Lengths of major-dimension vectors.
void gutsOfCopyOf(const bool colordered, const int minor, const int major, const CoinBigIndex numels, const double *elem, const int *ind, const CoinBigIndex *start, const int *len, const double extraMajor=0.0, const double extraGap=0.0)
void setMinorDim(int value)
Set minor dimension.
void nullElementArray()
NULLify element array.
int appendMinor(const int number, const CoinBigIndex *starts, const int *index, const double *element, int numberOther=-1)
Append a set of rows (columns) to the end of a column (row) ordered matrix.
void gutsOfOpEqual(const bool colordered, const int minor, const int major, const CoinBigIndex numels, const double *elem, const int *ind, const CoinBigIndex *start, const int *len)
void timesMajor(const double *x, double *y) const
Return A * x (multiplied from the "right" direction) in y.
void replaceVector(const int index, const int numReplace, const double *newElements)
Replace the elements of a vector.
double getExtraGap() const
Return the current setting of the extra gap.
void appendMajorVectors(const int numvecs, const CoinPackedVectorBase *const *vecs)
Append several major-dimensonvectors to the end of the matrix.
int appendMajor(const int number, const CoinBigIndex *starts, const int *index, const double *element, int numberOther=-1)
Append a set of rows (columns) to the end of a row (colum) ordered matrix.
int * getMajorIndices() const
Returns an array containing major indices.
void reverseOrdering()
Reverse the ordering of the packed matrix.
void appendMajorVector(const CoinPackedVectorBase &vec)
Append a major-dimension vector to the end of the matrix.
double extraGap_
This much times more space should be allocated for each major-dimension vector (with respect to the n...
void assignMatrix(const bool colordered, const int minor, const int major, const CoinBigIndex numels, double *&elem, int *&ind, CoinBigIndex *&start, int *&len, const int maxmajor=-1, const CoinBigIndex maxsize=-1)
Assign the arguments to the matrix.
void appendMinorVector(const CoinPackedVectorBase &vec)
Append a minor-dimension vector to the end of the matrix.
Error Class thrown by an exception.
int verifyMtx(int verbosity=1, bool zeroesAreError=false) const
Scan the matrix for anomalies.
bool isEquivalent(const CoinPackedVectorBase &rhs, const FloatEqual &eq) const
equivalent - If shallow packed vector A & B are equivalent, then they are still equivalent no matter ...
void appendCols(const int numcols, const CoinPackedVectorBase *const *cols)
Append a set of columns to the end of the matrix.
Equality to a scaled tolerance.
friend void CoinPackedMatrixUnitTest()
Test the methods in the CoinPackedMatrix class.
void deleteMajorVectors(const int numDel, const int *indDel)
Delete the major-dimension vectors whose indices are listed in indDel.
void copyOf(const CoinPackedMatrix &rhs)
Copy method.
bool isColOrdered() const
Whether the packed matrix is column major ordered or not.
void removeGaps(double removeValue=-1.0)
Remove the gaps from the matrix if there were any Can also remove small elements fabs() <= removeValu...
void timesMinor(const double *x, double *y) const
Return A * x (multiplied from the "right" direction) in y.
void majorAppendOrthoOrdered(const CoinPackedMatrix &matrix)
Append the rows of the argument to the right end of this matrix.
void appendRows(const int numrows, const CoinPackedVectorBase *const *rows)
Append a set of rows to the end of the matrix.
CoinPackedMatrix()
Default Constructor creates an empty column ordered packed matrix.
void resizeForAddingMinorVectors(const int *addedEntries)
void deleteCols(const int numDel, const int *indDel)
Delete the columns whose indices are listed in indDel.
void swap(CoinPackedMatrix &matrix)
Swap the content of two packed matrices.
int getNumCols() const
Number of columns.
bool isEquivalent(const CoinPackedMatrix &rhs, const FloatEqual &eq) const
Test for equivalence.