Warning: this documentation for the development version is under construction.
Index of Seldon Functions and Methods
| Add | adds two vectors/matrices |
| AddInteraction (sparse vectors) | adds a coefficient to the vector |
| AddInteractionRow (sparse vectors) | adds coefficients to the vector |
| AddInteraction (sparse matrices) | adds/inserts an element in the matrix |
| AddInteractionColumn (sparse matrices) | adds/inserts elements in a matrix column |
| AddInteractionRow (sparse matrices) | adds/inserts an element in a matrix row |
| ApplyRot | applies rotation to 2-D points |
| ApplyModifRot | applies rotation to 2-D points |
| Assemble | assembles a vector |
| Assemble (sparse vectors) | sorts row numbers |
| AssembleRow / AssembleColumn (sparse matrices) | assembles a row |
| BiCg | BIConjugate Gradient |
| BiCgcr | BIConjugate Gradient Conjugate Residual |
| BiCgStab | BIConjugate Gradient STABilized |
| BiCgStabl | BIConjugate Gradient STABilized (L) |
| Cg | Conjugate Gradient |
| Cgne | Conjugate Gradient Normal Equation |
| Cgs | Conjugate Gradient Squared |
| Clear (dense vectors) | removes all elements of the vector |
| Clear (sparse vectors) | removes all elements of the vector |
| Clear (dense matrices) | removes all elements of the matrix |
| Clear (sparse matrices) | removes all elements of the matrix |
| ClearRow / ClearColumn (sparse matrices) | clears a row |
| CoCg | Conjugate Orthogonal Conjugate Gradient |
| Conjugate | conjugates a vector |
| Copy | copies one vector/matrix into another one (conversion if needed) |
| Copy (dense vectors) | copies a vector |
| Copy (sparse vectors) | copies a vector |
| Copy (dense matrices) | copies a matrix |
| DotProd | scalar product between two vectors |
| DotProdConj | scalar product between two vectors, first vector being conjugated |
| ErrorCode (iteration) | returns error code |
| Fail (iteration) | informs that the iterative solver failed |
| Fill (dense vectors) | sets all elements to a given value |
| Fill (sparse vectors) | sets all elements to a given value |
| Fill (dense matrices) | sets all elements to a given value |
| Fill (sparse matrices) | sets all elements to a given value |
| FillRand (dense vectors) | fills randomly the vector |
| FillRand (sparse vectors) | fills randomly the vector |
| FillRand (dense matrices) | fills randomly the matrix |
| FillRand (sparse matrices) | fills randomly the matrix |
| Finished (iteration) | returns true if the stopping criteria are satisfied |
| First (iteration) | returns true for the first iteration |
| Gcr | Generalized Conjugate Residual |
| GetCol | returns a matrix column |
| GetData (dense vectors) | returns a pointer to the array contained in the vector |
| GetData (sparse vectors) | returns a pointer to the values |
| GetData (dense matrices) | returns a pointer to the array containing the values |
| GetData (sparse matrices) | returns a pointer to the array containing the values |
| GetData (CSR matrices) | returns a pointer to the array containing the values |
| GetDataConst (dense vectors) | returns a pointer to the array contained in the vector |
| GetDataConst (sparse vectors) | returns a pointer to the values |
| GetDataConst (dense matrices) | returns a pointer to the array containing the values |
| GetDataConstVoid (dense vectors) | returns a pointer to the array contained in the vector |
| GetDataConstVoid (sparse vectors) | returns a pointer to the values |
| GetDataConstVoid (dense matrices) | returns a pointer to the array containing the values |
| GetDataSize (dense vectors) | returns the number of elements in the vector |
| GetDataSize (sparse vectors) | returns the number of elements in the vector |
| GetDataSize (dense matrices) | returns the number of elements effectively stored |
| GetDataSize (sparse matrices) | returns the number of elements effectively stored |
| GetDataVoid (dense vectors) | returns a pointer to the array contained in the vector |
| GetDataVoid (sparse vectors) | returns a pointer to the values |
| GetDataVoid (dense matrices) | returns a pointer to the array containing the values |
| GetEigenvalues | computes eigenvalues |
| GetEigenvaluesEigenvectors | computes eigenvalues and eigenvectors |
| GetInd (CSR matrices) | returns a pointer to the array containing column numbers |
| GetIndex (sparse vectors) | returns a pointer to the row numbers |
| GetIndex (sparse matrices) | returns a pointer to the array containing column numbers |
| GetIndSize (CSR matrices) | returns size of array Ind |
| GetInverse | computes the matrix inverse |
| GetIterationNumber (iteration) | returns iteration number |
| GetLength (dense vectors) | returns the number of elements in the vector |
| GetLength (sparse vectors) | returns the number of elements in the vector |
| GetLQ | LQ factorization of matrix |
| GetLU | performs a LU (or LDL^t) factorization |
| GetM (dense vectors) | returns the number of elements in the vector |
| GetM (sparse vectors) | returns the number of elements in the vector |
| GetM (dense matrices) | returns the number of rows in the matrix |
| GetM (sparse matrices) | returns the number of rows in the matrix |
| GetMaxAbsIndex | returns index where highest absolute value is reached |
| GetN (dense matrices) | returns the number of columns in the matrix |
| GetN (sparse matrices) | returns the number of columns in the matrix |
| GetNonZeros (sparse matrices) | returns the number of elements effectively stored |
| GetNormInf (dense vectors) | returns highest absolute value |
| GetNormInf (sparse vectors) | returns highest absolute value |
| GetNormInfIndex (dense vectors) | returns the index of the highest absolute value |
| GetNormInfIndex (sparse vectors) | returns the index of the highest absolute value |
| GetPtr (CSR matrices) | returns a pointer to the array containing row numbers |
| GetPtrSize (CSR matrices) | returns size of array Ptr |
| GetQ_FromQR | Forms explicitely Q from QR factorization |
| GetQR | QR factorization of matrix |
| GetRestart (iteration) | returns restart parameter |
| GetRow | returns a matrix row |
| GetRowSize / GetColumnSize (sparse matrices) | returns the number of elements in the row |
| GetScalingFactors | computes row and column scalings to equilibrate a matrix |
| GetSchurMatrix | forms Schur complement |
| GetSize (dense vectors) | returns the number of elements in the vector |
| GetSize (sparse vectors) | returns the number of elements in the vector |
| GetSize (dense matrices) | returns the number of elements in the matrix |
| GetSVD | performs singular value decomposition (SVD) |
| GetTolerance (iteration) | returns stopping criterion |
| Gmres | Generalized Minimum RESidual |
| Index (sparse vectors) | access to row number |
| Index (sparse matrices) | direct access to a column number |
| Init (iteration) | provides right hand side |
| IsInitGuess_Null (iteration) | returns true if the initial guess is zero |
| Lsqr | Least SQuaRes |
| MaxAbs | returns highest absolute value of A |
| MergeSort | sorts a vector with merge sort algorithm |
| MinRes | Minimum RESidual |
| Mlt | multiplication by a scalar or matrix-vector product |
| MltAdd | performs a matrix-vector or matrix-matrix product |
| MltQ_FromQR | multiplies vector by Q |
| Norm1 | returns 1-norm of a vector |
| Norm1 | returns 1-norm of A |
| Norm2 | returns 2-norm of a vector |
| NormInf | returns infinity-norm of A |
| Nullify (dense vectors) | clears the vector without releasing memory |
| Nullify (sparse vectors) | clears the vector without releasing memory |
| Nullify (dense matrices) | clears the matrix without releasing memory |
| Nullify (sparse matrices) | removes elements of the matrix without releasing memory |
| Nullify (CSR matrices) | clears the matrix without releasing memory |
| ApplyInversePermutation | permutes row and column numbers of a matrix |
| Print (dense vectors) | displays the vector |
| Print (sparse vectors) | displays the vector |
| Print (dense matrices) | displays the matrix |
| Print (sparse matrices) | displays the matrix |
| PrintRow / PrintColumn (sparse matrices) | prints a row |
| PushBack (dense vectors) | adds an element to the end of the vector |
| QCgs | Quasi Conjugate Gradient Squared |
| Qmr | Quasi Minimum Residual |
| QmrSym | Quasi Minimum Residual SYMmetric |
| QuickSort | sorts a vector with quick sort algorithm |
| Rank1Update | Adds a contribution X.Y' to a matrix |
| Rank2Update | Adds a contribution X.Y' + Y.X' to a symmetric matrix |
| Read (dense vectors) | reads the vector in binary format |
| Read (sparse vectors) | reads the vector in binary format |
| Read (dense matrices) | reads the matrix in binary format |
| Read (sparse matrices) | reads the vector in binary format |
| ReadText (dense vectors) | reads the vector in text format |
| ReadText (sparse vectors) | reads the vector in text format |
| ReadText (dense matrices) | reads the matrix in text format |
| ReadText (sparse matrices) | reads the vector in text format |
| Reallocate (dense vectors) | changes the size of vector (removes previous elements) |
| Reallocate (sparse vectors) | changes the size of vector (removes previous elements) |
| Reallocate (dense matrices) | changes the size of matrix (does not keep previous elements) |
| Reallocate (sparse matrices) | changes the size of matrix (does not keep previous elements) |
| ReallocateRow / ReallocateColumn (sparse matrices) | changes the size of a row |
| ReciprocalConditionNumber | computes the inverse of matrix condition number |
| RefineSolutionLU | improves solution computed by SolveLU |
| RemoveDuplicate | sorts and removes duplicate elements of a vector |
| ReplaceIndexRow / ReplaceIndexColumn (sparse matrices) | changes column numbers |
| Resize (dense vectors) | changes the size of vector (keeps previous elements) |
| Resize (sparse vectors) | changes the size of vector (keeps previous elements) |
| Resize (dense matrices) | changes the size of matrix (keeps previous elements) |
| Resize (sparse matrices) | changes the size of matrix (keeps previous elements) |
| ResizeRow / ResizeColumn (sparse matrices) | changes the size of a row and keeps previous values |
| ScaleLeftMatrix | multiplies rows of a matrix by coefficients |
| ScaleMatrix | multiplies rows and columns of a matrix by coefficients |
| SetCol | changes a matrix column |
| SetData (dense vectors) | sets the pointer to the array contained in the vector |
| SetData (sparse vectors) | sets the pointer to the array contained in the vector |
| SetData (dense matrices) | sets the pointer to the array containing the values |
| SetData (sparse matrices) | sets the pointer to the arrays containing values and column numbers |
| SetData (CSR matrices) | sets the pointer to the array containing the values |
| SetIdentity (dense matrices) | sets matrix to identity matrix |
| SetIdentity (sparse matrices) | sets matrix to identity matrix |
| SetInitGuess (iteration) | informs if the initial guess is zero or no |
| SetIterationNumber (iteration) | changes iteration number |
| SetMaxIterationNumber (iteration) | changes maximum number of iterations |
| SetRestart (iteration) | changes restart parameter |
| SetRow | changes a matrix row |
| SetTolerance (iteration) | changes stopping criterion |
| ShowMessages (iteration) | displays residual each 100 iterations |
| ShowFullHistory (iteration) | displays residual each iteration |
| Solve | solves a triangular system |
| Solve (preconditioning) | Applies the preconditioner |
| SolveLQ | solves least-square problems by using LQ factorization |
| SolveLU | solve linear system by using LU factorization |
| SolveQR | solves least-square problems by using QR factorization |
| SOR | applies successive over-relaxations to matrix |
| Sort | sorts a vector |
| Swap | exchanges two vectors |
| SwapRow / SwapColumn (sparse matrices) | exchanges two rows |
| Symmlq | SYMMetric Least sQuares |
| TfQmr | Transpose Free Quasi Minimum Residual |
| Transpose | replaces a matrix by its transpose |
| TransposeConj | replaces a matrix by its conjugate transpose |
| TransSolve (preconditioning) | Applies the transpose of the preconditioner |
| Val (dense matrices) | access to a matrix element |
| Value (sparse vectors) | access to value |
| Value (sparse matrices) | direct access to a value |
| Write (dense vectors) | writes the vector in binary format |
| Write (sparse vectors) | writes the vector in binary format |
| Write (dense matrices) | writes the matrix in binary format |
| Write (sparse matrices) | writes the vector in binary format |
| WriteText (dense vectors) | writes the vector in text format |
| WriteText (sparse vectors) | writes the vector in text format |
| WriteText (dense matrices) | writes the matrix in text format |
| WriteText (sparse matrices) | writes the vector in text format |
| Zero (dense vectors) | sets all elements to zero |
| Zero (sparse vectors) | sets all elements to zero |
| Zero (dense matrices) | sets all elements to zero |
| Zero (sparse matrices) | sets all elements to zero |
