a new object with type S, a subtype of T
|
|
|
appendOptionsPrefix(self,
prefix)
Appends to the prefix used for searching for all SVD options
in the database. |
|
|
|
cancelMonitor(self)
Clears all monitors for an SVD object. |
|
|
|
computeError(self,
int i,
etype=None)
Computes the error (based on the residual norm) associated with the i-th
singular triplet. |
|
|
|
create(self,
comm=None)
Creates the SVD object. |
|
|
|
destroy(self)
Destroys the SVD object. |
|
|
|
errorView(self,
etype=None,
Viewer viewer=None)
Displays the errors associated with the computed solution
(as well as the eigenvalues). |
|
|
|
getBV(self)
Obtain the basis vectors objects associated to the SVD object. |
|
|
|
getConverged(self)
Gets the number of converged singular triplets. |
|
|
|
|
|
getCrossEPS(self)
Retrieve the eigensolver object (EPS) associated to the
singular value solver. |
|
|
|
getCyclicEPS(self)
Retrieve the eigensolver object (EPS) associated to the
singular value solver. |
|
|
|
|
|
getDimensions(self)
Gets the number of singular values to compute and the
dimension of the subspace. |
|
|
|
getImplicitTranspose(self)
Gets the mode used to handle the transpose of the matrix
associated with the singular value problem. |
|
|
|
|
|
getOperators(self)
Gets the matrices associated with the singular value problem. |
|
|
|
getOptionsPrefix(self)
Gets the prefix used for searching for all SVD options in the
database. |
|
|
|
|
|
getSingularTriplet(self,
int i,
Vec U=None,
Vec V=None)
Gets the i-th triplet of the singular value decomposition as
computed by solve(). |
|
|
|
getTolerances(self)
Gets the tolerance and maximum iteration count used by the
default SVD convergence tests. |
|
|
|
getType(self)
Gets the SVD type of this object. |
|
|
|
|
|
getVectors(self,
int i,
Vec U,
Vec V)
Gets the i-th left and right singular vectors as computed by
solve(). |
|
|
|
|
|
isGeneralized(self)
Tells whether the SVD object corresponds to a generalized
singular value problem. |
|
|
|
reset(self)
Resets the SVD object. |
|
|
|
setBV(self,
BV V,
BV U=None)
Associates basis vectors objects to the SVD solver. |
|
|
|
setCrossEPS(self,
EPS eps)
Associate an eigensolver object (EPS) to the singular value
solver. |
|
|
|
setCyclicEPS(self,
EPS eps)
Associate an eigensolver object (EPS) to the singular value
solver. |
|
|
|
setCyclicExplicitMatrix(self,
flag=True)
Indicate if the eigensolver operator H(A) = [ 0 A ; A^T 0
] must be computed explicitly. |
|
|
|
setDimensions(self,
nsv=None,
ncv=None,
mpd=None)
Sets the number of singular values to compute and the
dimension of the subspace. |
|
|
|
|
|
setImplicitTranspose(self,
mode)
Indicates how to handle the transpose of the matrix
associated with the singular value problem. |
|
|
|
setInitialSpaces(self,
spaceright=None,
spaceleft=None)
Sets the initial spaces from which the SVD solver starts to
iterate. |
|
|
|
setLanczosOneSide(self,
flag=True)
Indicate if the variant of the Lanczos method to be used is
one-sided or two-sided. |
|
|
|
setOperator(self,
Mat A,
Mat B=None)
Sets the matrices associated with the singular value problem. |
|
|
|
setOperators(self,
Mat A,
Mat B=None)
Sets the matrices associated with the singular value problem. |
|
|
|
setOptionsPrefix(self,
prefix)
Sets the prefix used for searching for all SVD options in the
database. |
|
|
|
setProblemType(self,
problem_type)
Specifies the type of the singular value problem. |
|
|
|
setTRLanczosOneSide(self,
flag=True)
Indicate if the variant of the thick-restart Lanczos method to
be used is one-sided or two-sided. |
|
|
|
setTolerances(self,
tol=None,
max_it=None)
Sets the tolerance and maximum iteration count used by the
default SVD convergence tests. |
|
|
|
setType(self,
svd_type)
Selects the particular solver to be used in the SVD object. |
|
|
|
setUp(self)
Sets up all the internal data structures necessary for the
execution of the singular value solver. |
|
|
|
|
|
solve(self)
Solves the singular value problem. |
|
|
|
view(self,
Viewer viewer=None)
Prints the SVD data structure. |
|
|
Inherited from petsc4py.PETSc.Object :
__copy__ ,
__deepcopy__ ,
__eq__ ,
__ge__ ,
__gt__ ,
__le__ ,
__lt__ ,
__ne__ ,
__nonzero__ ,
compose ,
decRef ,
getAttr ,
getClassId ,
getClassName ,
getComm ,
getDict ,
getName ,
getRefCount ,
getTabLevel ,
incRef ,
incrementTabLevel ,
query ,
setAttr ,
setName ,
setTabLevel ,
stateIncrease ,
viewFromOptions
Inherited from object :
__delattr__ ,
__format__ ,
__getattribute__ ,
__hash__ ,
__init__ ,
__reduce__ ,
__reduce_ex__ ,
__repr__ ,
__setattr__ ,
__sizeof__ ,
__str__ ,
__subclasshook__
|