Home | Trees | Indices | Help |
|
---|
|
|
|||
ConvergedReason SVD convergence reasons |
|||
TransposeMode SVD handling of the transpose of the matrix |
|||
Type SVD types |
|||
Which SVD desired piece of spectrum |
|
|||
a new object with type S, a subtype of T |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from |
|
|||
ip | |||
max_it | |||
tol | |||
transpose_mode | |||
which | |||
Inherited from Inherited from |
|
|
Computes the relative error bound associated with the i-th singular triplet. Parameters
Returns
NotesThe index i should be a value between 0 and nconv-1 (see getConverged(). Singular triplets are indexed according to the ordering criterion established with setWhichSingularTriplets(). |
Computes the norms of the residual vectors associated with the i-th computed singular triplet. Parameters
Returns
|
Creates the SVD object. Parameters
|
|
Gets the number of converged singular triplets. Returns
NotesThis function should be called after solve() has finished. |
Gets the reason why the solve() iteration was stopped. Returns
|
Retrieve the eigensolver object (EPS) associated to the singular value solver. Returns
|
Retrieve the eigensolver object (EPS) associated to the singular value solver. Returns
|
Returns the flag indicating if H(A) = [ 0 A ; A^T 0 ] is built explicitly. Returns
|
Gets the number of singular values to compute and the dimension of the subspace. Returns
|
Obtain the inner product object associated to the SVD object. Returns
|
Gets the initial vector associated with the SVD solver; if the vector was not set it will return a 0 pointer or a vector randomly generated by setUp(). Returns
|
Gets the current iteration number. If the call to solve() is complete, then it returns the number of iterations carried out by the solution method. Returns
|
Gets the total number of matrix-vector and dot products used by the SVD object during the last solve() call. Returns
NotesThese counters are reset to zero at each successive call to solve(). |
Gets the matrix associated with the singular value problem. Returns
|
Gets the prefix used for searching for all SVD options in the database. Returns
|
Gets the i-th triplet of the singular value decomposition as computed by solve(). The solution consists of the singular value and its left and right singular vectors. Parameters
Returns
NotesThe index i should be a value between 0 and nconv-1 (see getConverged(). Singular triplets are indexed according to the ordering criterion established with setWhichSingularTriplets(). |
Gets the tolerance and maximum iteration count used by the default SVD convergence tests. Returns
|
Gets the mode used to compute the transpose of the matrix associated with the singular value problem. Returns
|
Gets the SVD type of this object. Returns
|
Gets the i-th singular value as computed by solve(). Parameters
Returns
NotesThe index i should be a value between 0 and nconv-1 (see getConverged(). Singular triplets are indexed according to the ordering criterion established with setWhichSingularTriplets(). |
Gets the i-th left and right singular vectors as computed by solve(). Parameters
NotesThe index i should be a value between 0 and nconv-1 (see getConverged(). Singular triplets are indexed according to the ordering criterion established with setWhichSingularTriplets(). |
Returns which singular triplets are to be sought. Returns
|
Associate an eigensolver object (EPS) to the singular value solver. Parameters
|
Associate an eigensolver object (EPS) to the singular value solver. Parameters
|
Indicate if the eigensolver operator H(A) = [ 0 A ; A^T 0 ] must be computed explicitly. Parameters
|
Sets the number of singular values to compute and the dimension of the subspace. Parameters
NotesUse DECIDE for The parameters
The value of |
Sets SVD options from the options database. This routine must be called before setUp() if the user is to be allowed to set the solver type. NotesTo see all options, run your program with the -help option.
|
Associates an inner product object to the SVD solver. Parameters
|
Sets the initial vector from which the SVD solver starts to iterate. Parameters
|
Indicate if the variant of the Lanczos method to be used is one-sided or two-sided. Parameters
NotesBy default, a two-sided variant is selected, which is sometimes slightly more robust. However, the one-sided variant is faster because it avoids the orthogonalization associated to left singular vectors. It also saves the memory required for storing such vectors. |
Sets the matrix associated with the singular value problem. Parameters
|
Sets the prefix used for searching for all SVD options in the database. Parameters
NotesA hyphen (-) must NOT be given at the beginning of the prefix name. The first character of all runtime options is AUTOMATICALLY the hyphen. For example, to distinguish between the runtime options for two different SVD contexts, one could call: S1.setOptionsPrefix("svd1_") S2.setOptionsPrefix("svd2_")
|
Indicate if the variant of the thick-restart Lanczos method to be used is one-sided or two-sided. Parameters
NotesBy default, a two-sided variant is selected, which is sometimes slightly more robust. However, the one-sided variant is faster because it avoids the orthogonalization associated to left singular vectors. |
Sets the tolerance and maximum iteration count used by the default SVD convergence tests. Parameters
NotesUse DECIDE for max_it to assign a reasonably good value, which is dependent on the solution method. |
Sets the mode used to compute the transpose of the matrix associated with the singular value problem. Parameters
NotesIn the SVD.TransposeMode.EXPLICIT mode, the transpose of the matrix is explicitly built. The option SVD.TransposeMode.IMPLICIT does not build the transpose, but handles it implicitly via multTranspose() matrix operation. This is likely to be more inefficient than SVD.TransposeMode.EXPLICIT, both in sequential and in parallel, but requires less storage. The default is SVD.TransposeMode.EXPLICIT if the matrix has defined the transpose() matrix operation, and SVD.TransposeMode.IMPLICIT otherwise. |
Selects the particular solver to be used in the SVD object. Parameters
NotesSee SVD.Type for available methods. The default is CROSS. Normally, it is best to use setFromOptions() and then set the SVD type from the options database rather than by using this routine. Using the options database provides the user with maximum flexibility in evaluating the different available methods. |
Sets up all the internal data structures necessary for the execution of the singular value solver. NotesThis function need not be called explicitly in most cases, since solve() calls it. It can be useful when one wants to measure the set-up time separately from the solve time. |
Specifies which singular triplets are to be sought. Parameters
|
Prints the SVD data structure. Parameters
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Tue Mar 31 16:20:40 2009 | http://epydoc.sourceforge.net |