MLIR  16.0.0git
Public Member Functions | Static Public Member Functions | List of all members
mlir::presburger::Matrix Class Reference

This is a class to represent a resizable matrix. More...

#include "mlir/Analysis/Presburger/Matrix.h"

Public Member Functions

 Matrix ()=delete
 
 Matrix (unsigned rows, unsigned columns, unsigned reservedRows=0, unsigned reservedColumns=0)
 Construct a matrix with the specified number of rows and columns. More...
 
MPIntat (unsigned row, unsigned column)
 Access the element at the specified row and column. More...
 
MPInt at (unsigned row, unsigned column) const
 
MPIntoperator() (unsigned row, unsigned column)
 
MPInt operator() (unsigned row, unsigned column) const
 
void swapColumns (unsigned column, unsigned otherColumn)
 Swap the given columns. More...
 
void swapRows (unsigned row, unsigned otherRow)
 Swap the given rows. More...
 
unsigned getNumRows () const
 
unsigned getNumColumns () const
 
unsigned getNumReservedRows () const
 Return the maximum number of rows/columns that can be added without incurring a reallocation. More...
 
unsigned getNumReservedColumns () const
 
void reserveRows (unsigned rows)
 Reserve enough space to resize to the specified number of rows without reallocations. More...
 
MutableArrayRef< MPIntgetRow (unsigned row)
 Get a [Mutable]ArrayRef corresponding to the specified row. More...
 
ArrayRef< MPIntgetRow (unsigned row) const
 
void setRow (unsigned row, ArrayRef< MPInt > elems)
 Set the specified row to elems. More...
 
void insertColumns (unsigned pos, unsigned count)
 Insert columns having positions pos, pos + 1, ... More...
 
void insertColumn (unsigned pos)
 
void insertRows (unsigned pos, unsigned count)
 Insert rows having positions pos, pos + 1, ... More...
 
void insertRow (unsigned pos)
 
void removeColumns (unsigned pos, unsigned count)
 Remove the columns having positions pos, pos + 1, ... More...
 
void removeColumn (unsigned pos)
 
void removeRows (unsigned pos, unsigned count)
 Remove the rows having positions pos, pos + 1, ... More...
 
void removeRow (unsigned pos)
 
void copyRow (unsigned sourceRow, unsigned targetRow)
 
void fillRow (unsigned row, const MPInt &value)
 
void fillRow (unsigned row, int64_t value)
 
void addToRow (unsigned sourceRow, unsigned targetRow, const MPInt &scale)
 Add scale multiples of the source row to the target row. More...
 
void addToRow (unsigned sourceRow, unsigned targetRow, int64_t scale)
 
void addToRow (unsigned row, ArrayRef< MPInt > rowVec, const MPInt &scale)
 Add scale multiples of the rowVec row to the specified row. More...
 
void addToColumn (unsigned sourceColumn, unsigned targetColumn, const MPInt &scale)
 Add scale multiples of the source column to the target column. More...
 
void addToColumn (unsigned sourceColumn, unsigned targetColumn, int64_t scale)
 
void negateColumn (unsigned column)
 Negate the specified column. More...
 
void negateRow (unsigned row)
 Negate the specified row. More...
 
MPInt normalizeRow (unsigned row, unsigned nCols)
 Divide the first nCols of the specified row by their GCD. More...
 
MPInt normalizeRow (unsigned row)
 Divide the columns of the specified row by their GCD. More...
 
SmallVector< MPInt, 8 > preMultiplyWithRow (ArrayRef< MPInt > rowVec) const
 The given vector is interpreted as a row vector v. More...
 
SmallVector< MPInt, 8 > postMultiplyWithColumn (ArrayRef< MPInt > colVec) const
 The given vector is interpreted as a column vector v. More...
 
std::pair< Matrix, MatrixcomputeHermiteNormalForm () const
 Given the current matrix M, returns the matrices H, U such that H is the column hermite normal form of M, i.e. More...
 
void resize (unsigned newNRows, unsigned newNColumns)
 Resize the matrix to the specified dimensions. More...
 
void resizeHorizontally (unsigned newNColumns)
 
void resizeVertically (unsigned newNRows)
 
unsigned appendExtraRow ()
 Add an extra row at the bottom of the matrix and return its position. More...
 
unsigned appendExtraRow (ArrayRef< MPInt > elems)
 Same as above, but copy the given elements into the row. More...
 
void print (raw_ostream &os) const
 Print the matrix. More...
 
void dump () const
 
bool hasConsistentState () const
 Return whether the Matrix is in a consistent state with all its invariants satisfied. More...
 

Static Public Member Functions

static Matrix identity (unsigned dimension)
 Return the identity matrix of the specified dimension. More...
 

Detailed Description

This is a class to represent a resizable matrix.

More columns and rows can be reserved than are currently used. The data is stored as a single 1D array, viewed as a 2D matrix with nRows rows and nReservedColumns columns, stored in row major form. Thus the element at (i, j) is stored at data[i*nReservedColumns + j]. The reserved but unused columns always have all zero values. The reserved rows are just reserved space in the underlying SmallVector's capacity.

Definition at line 35 of file Matrix.h.

Constructor & Destructor Documentation

◆ Matrix() [1/2]

mlir::presburger::Matrix::Matrix ( )
delete

◆ Matrix() [2/2]

Matrix::Matrix ( unsigned  rows,
unsigned  columns,
unsigned  reservedRows = 0,
unsigned  reservedColumns = 0 
)

Construct a matrix with the specified number of rows and columns.

The number of reserved rows and columns will be at least the number specified, and will always be sufficient to accomodate the number of rows and columns specified.

Initially, the entries are initialized to ero.

Definition at line 16 of file Matrix.cpp.

References max().

Member Function Documentation

◆ addToColumn() [1/2]

void Matrix::addToColumn ( unsigned  sourceColumn,
unsigned  targetColumn,
const MPInt scale 
)

◆ addToColumn() [2/2]

void mlir::presburger::Matrix::addToColumn ( unsigned  sourceColumn,
unsigned  targetColumn,
int64_t  scale 
)
inline

◆ addToRow() [1/3]

void Matrix::addToRow ( unsigned  sourceRow,
unsigned  targetRow,
const MPInt scale 
)

Add scale multiples of the source row to the target row.

Definition at line 194 of file Matrix.cpp.

References getRow().

Referenced by addToRow(), fillRow(), mlir::presburger::GBRSimplex::removeLastEquality(), and mlir::presburger::MultiAffineFunction::subtract().

◆ addToRow() [2/3]

void mlir::presburger::Matrix::addToRow ( unsigned  sourceRow,
unsigned  targetRow,
int64_t  scale 
)
inline

Definition at line 133 of file Matrix.h.

References addToColumn(), and addToRow().

◆ addToRow() [3/3]

void Matrix::addToRow ( unsigned  row,
ArrayRef< MPInt rowVec,
const MPInt scale 
)

Add scale multiples of the rowVec row to the specified row.

Definition at line 199 of file Matrix.cpp.

References at().

◆ appendExtraRow() [1/2]

unsigned Matrix::appendExtraRow ( )

◆ appendExtraRow() [2/2]

unsigned Matrix::appendExtraRow ( ArrayRef< MPInt elems)

Same as above, but copy the given elements into the row.

The length of elems must be equal to the number of columns.

Definition at line 44 of file Matrix.cpp.

References appendExtraRow(), and at().

◆ at() [1/2]

MPInt& mlir::presburger::Matrix::at ( unsigned  row,
unsigned  column 
)
inline

◆ at() [2/2]

MPInt mlir::presburger::Matrix::at ( unsigned  row,
unsigned  column 
) const
inline

Definition at line 58 of file Matrix.h.

◆ computeHermiteNormalForm()

std::pair< Matrix, Matrix > Matrix::computeHermiteNormalForm ( ) const

Given the current matrix M, returns the matrices H, U such that H is the column hermite normal form of M, i.e.

H = M * U, where U is unimodular and the matrix H has the following restrictions:

  • H is lower triangular.
  • The leading coefficient (the first non-zero entry from the top, called the pivot) of a non-zero column is always strictly below of the leading coefficient of the column before it; moreover, it is positive.
  • The elements to the right of the pivots are zero and the elements to the left of the pivots are nonnegative and strictly smaller than the pivot.

Definition at line 269 of file Matrix.cpp.

References getNumColumns(), getNumRows(), identity(), modEntryColumnOperation(), negateColumn(), and swapColumns().

Referenced by addToColumn(), and mlir::presburger::LinearTransform::makeTransformToColumnEchelon().

◆ copyRow()

void Matrix::copyRow ( unsigned  sourceRow,
unsigned  targetRow 
)

◆ dump()

void Matrix::dump ( ) const

Definition at line 363 of file Matrix.cpp.

References print().

Referenced by addToColumn().

◆ fillRow() [1/2]

void Matrix::fillRow ( unsigned  row,
const MPInt value 
)

◆ fillRow() [2/2]

void mlir::presburger::Matrix::fillRow ( unsigned  row,
int64_t  value 
)
inline

Definition at line 129 of file Matrix.h.

References addToRow(), and fillRow().

Referenced by fillRow().

◆ getNumColumns()

unsigned mlir::presburger::Matrix::getNumColumns ( ) const
inline

◆ getNumReservedColumns()

unsigned mlir::presburger::Matrix::getNumReservedColumns ( ) const
inline

◆ getNumReservedRows()

unsigned Matrix::getNumReservedRows ( ) const

Return the maximum number of rows/columns that can be added without incurring a reallocation.

Definition at line 31 of file Matrix.cpp.

Referenced by getNumColumns(), mlir::presburger::IntegerRelation::getNumReservedEqualities(), and mlir::presburger::IntegerRelation::getNumReservedInequalities().

◆ getNumRows()

unsigned mlir::presburger::Matrix::getNumRows ( ) const
inline

◆ getRow() [1/2]

MutableArrayRef< MPInt > Matrix::getRow ( unsigned  row)

◆ getRow() [2/2]

ArrayRef< MPInt > Matrix::getRow ( unsigned  row) const

Definition at line 91 of file Matrix.cpp.

◆ hasConsistentState()

bool Matrix::hasConsistentState ( ) const

Return whether the Matrix is in a consistent state with all its invariants satisfied.

Definition at line 365 of file Matrix.cpp.

Referenced by addToColumn(), and mlir::presburger::IntegerRelation::hasConsistentState().

◆ identity()

Matrix Matrix::identity ( unsigned  dimension)
static

Return the identity matrix of the specified dimension.

Definition at line 24 of file Matrix.cpp.

Referenced by computeHermiteNormalForm(), and mlir::presburger::Simplex::findIntegerSample().

◆ insertColumn()

void Matrix::insertColumn ( unsigned  pos)

Definition at line 102 of file Matrix.cpp.

References insertColumns().

Referenced by getNumReservedColumns(), and mlir::presburger::DivisionRepr::insertDiv().

◆ insertColumns()

void Matrix::insertColumns ( unsigned  pos,
unsigned  count 
)

Insert columns having positions pos, pos + 1, ...

pos + count - 1. Columns that were at positions 0 to pos - 1 will stay where they are; columns that were at positions pos to nColumns - 1 will be pushed to the right. pos should be at most nColumns.

Definition at line 103 of file Matrix.cpp.

Referenced by getNumReservedColumns(), insertColumn(), mlir::presburger::DivisionRepr::insertDiv(), mlir::presburger::MultiAffineFunction::mergeDivs(), and resizeHorizontally().

◆ insertRow()

void Matrix::insertRow ( unsigned  pos)

Definition at line 158 of file Matrix.cpp.

References insertRows().

Referenced by getNumReservedColumns().

◆ insertRows()

void Matrix::insertRows ( unsigned  pos,
unsigned  count 
)

Insert rows having positions pos, pos + 1, ...

pos + count - 1. Rows that were at positions 0 to pos - 1 will stay where they are; rows that were at positions pos to nColumns - 1 will be pushed to the right. pos should be at most nRows.

Definition at line 159 of file Matrix.cpp.

References at(), copyRow(), and resizeVertically().

Referenced by getNumReservedColumns(), mlir::presburger::DivisionRepr::insertDiv(), and insertRow().

◆ negateColumn()

void Matrix::negateColumn ( unsigned  column)

Negate the specified column.

Definition at line 215 of file Matrix.cpp.

References at(), and getNumRows().

Referenced by addToColumn(), and computeHermiteNormalForm().

◆ negateRow()

void Matrix::negateRow ( unsigned  row)

Negate the specified row.

Definition at line 220 of file Matrix.cpp.

References at(), and getNumColumns().

Referenced by addToColumn(), and mlir::presburger::IntegerRelation::removeRedundantInequalities().

◆ normalizeRow() [1/2]

MPInt Matrix::normalizeRow ( unsigned  row,
unsigned  nCols 
)

◆ normalizeRow() [2/2]

MPInt Matrix::normalizeRow ( unsigned  row)

Divide the columns of the specified row by their GCD.

Returns the GCD of the columns of the specified row.

Definition at line 229 of file Matrix.cpp.

References getNumColumns(), and normalizeRow().

◆ operator()() [1/2]

MPInt& mlir::presburger::Matrix::operator() ( unsigned  row,
unsigned  column 
)
inline

Definition at line 64 of file Matrix.h.

References at().

◆ operator()() [2/2]

MPInt mlir::presburger::Matrix::operator() ( unsigned  row,
unsigned  column 
) const
inline

Definition at line 66 of file Matrix.h.

References at(), swapColumns(), and swapRows().

◆ postMultiplyWithColumn()

SmallVector< MPInt, 8 > Matrix::postMultiplyWithColumn ( ArrayRef< MPInt colVec) const

The given vector is interpreted as a column vector v.

Pre-multiply v with this matrix, say M, and return Mv.

Definition at line 244 of file Matrix.cpp.

References at(), getNumColumns(), and getNumRows().

Referenced by addToColumn(), mlir::presburger::LinearTransform::postMultiplyWithColumn(), and mlir::presburger::MultiAffineFunction::valueAt().

◆ preMultiplyWithRow()

SmallVector< MPInt, 8 > Matrix::preMultiplyWithRow ( ArrayRef< MPInt rowVec) const

The given vector is interpreted as a row vector v.

Post-multiply v with this matrix, say M, and return vM.

Definition at line 233 of file Matrix.cpp.

References at(), getNumColumns(), and getNumRows().

Referenced by addToColumn(), and mlir::presburger::LinearTransform::preMultiplyWithRow().

◆ print()

void Matrix::print ( raw_ostream &  os) const

Print the matrix.

Definition at line 355 of file Matrix.cpp.

References at().

Referenced by addToColumn(), dump(), mlir::presburger::MultiAffineFunction::print(), and mlir::presburger::DivisionRepr::print().

◆ removeColumn()

void Matrix::removeColumn ( unsigned  pos)

◆ removeColumns()

void Matrix::removeColumns ( unsigned  pos,
unsigned  count 
)

Remove the columns having positions pos, pos + 1, ...

pos + count - 1. Rows that were at positions 0 to pos - 1 will stay where they are; columns that were at positions pos + count - 1 or later will be pushed to the right. The columns to be deleted must be valid rows: pos + count - 1 must be at most nColumns - 1.

Definition at line 145 of file Matrix.cpp.

References at().

Referenced by getNumReservedColumns(), removeColumn(), and resizeHorizontally().

◆ removeRow()

void Matrix::removeRow ( unsigned  pos)

◆ removeRows()

void Matrix::removeRows ( unsigned  pos,
unsigned  count 
)

Remove the rows having positions pos, pos + 1, ...

pos + count - 1. Rows that were at positions 0 to pos - 1 will stay where they are; rows that were at positions pos + count - 1 or later will be pushed to the right. The rows to be deleted must be valid rows: pos + count - 1 must be at most nRows - 1.

Definition at line 173 of file Matrix.cpp.

References copyRow(), and resizeVertically().

Referenced by getNumReservedColumns(), mlir::presburger::IntegerRelation::removeEqualityRange(), mlir::presburger::IntegerRelation::removeInequalityRange(), mlir::presburger::MultiAffineFunction::removeOutputs(), and removeRow().

◆ reserveRows()

void Matrix::reserveRows ( unsigned  rows)

Reserve enough space to resize to the specified number of rows without reallocations.

Definition at line 35 of file Matrix.cpp.

Referenced by mlir::presburger::IntegerRelation::append(), getNumReservedColumns(), isRangeDivisibleBy(), and mlir::presburger::Simplex::makeProduct().

◆ resize()

void Matrix::resize ( unsigned  newNRows,
unsigned  newNColumns 
)

Resize the matrix to the specified dimensions.

If a dimension is smaller, the values are truncated; if it is bigger, the new values are initialized to zero.

Due to the representation of the matrix, resizing vertically (adding rows) is less expensive than increasing the number of columns beyond nReservedColumns.

Definition at line 59 of file Matrix.cpp.

References resizeHorizontally(), and resizeVertically().

Referenced by addToColumn().

◆ resizeHorizontally()

void Matrix::resizeHorizontally ( unsigned  newNColumns)

◆ resizeVertically()

void Matrix::resizeVertically ( unsigned  newNRows)

◆ setRow()

void Matrix::setRow ( unsigned  row,
ArrayRef< MPInt elems 
)

Set the specified row to elems.

Definition at line 95 of file Matrix.cpp.

References at(), and getNumColumns().

Referenced by getNumReservedColumns().

◆ swapColumns()

void Matrix::swapColumns ( unsigned  column,
unsigned  otherColumn 
)

◆ swapRows()

void Matrix::swapRows ( unsigned  row,
unsigned  otherRow 
)

Swap the given rows.

Definition at line 69 of file Matrix.cpp.

References at(), and getNumRows().

Referenced by operator()(), mlir::presburger::GBRSimplex::removeLastEquality(), and mlir::presburger::SimplexBase::swapRows().


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