Home | Trees | Indices | Help |
|
---|
|
FN
|
|||
CombineType FN type of combination of child functions |
|||
ParallelType FN parallel types |
|||
Type FN type |
|
|||
a new object with type S, a subtype of T |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from |
|
|||
method | |||
parallel | |||
Inherited from Inherited from |
|
|
Creates the FN object. Parameters ---------- comm: Comm, optional MPI communicator; if not provided, it defaults to all processes. |
Destroys the FN object.
|
Duplicate the FN object copying all parameters, possibly with a different communicator. Parameters ---------- comm: Comm, optional MPI communicator; if not provided, it defaults to the object's communicator. |
Computes the value of the derivative f'(x) for a given x. Parameters ---------- x: scalar Value where the derivative must be evaluated. Returns ------- y: scalar The result of f'(x). |
Computes the value of the function f(x) for a given x. Parameters ---------- x: scalar Value where the function must be evaluated. Returns ------- y: scalar The result of f(x). |
Computes the value of the function f(A) for a given matrix A. Parameters ---------- A: Mat Matrix on which the function must be evaluated. B: Mat, optional Placeholder for the result. Returns ------- B: Mat The result of f(A). |
Computes the first column of the matrix f(A) for a given matrix A. Parameters ---------- A: Mat Matrix on which the function must be evaluated. Returns ------- v: Vec The first column of the result f(A). |
Gets the two child functions that constitute this combined function, and the way they must be combined. Returns ------- comb: `FN.CombineType` enumerate How to combine the functions (addition, multiplication, division, composition). f1: FN First function. f2: FN Second function. |
Gets the method currently used for matrix functions. Returns ------- meth: int An index indentifying the method. |
Gets the prefix used for searching for all FN options in the database. Returns ------- prefix: string The prefix string set for this FN object.
|
Gets the mode of operation in parallel runs. Returns ------- pmode: `FN.ParallelType` enumerate The parallel mode. |
Gets the index of the phi-function. Returns ------- k: int The index. |
Gets the coefficients of the denominator of the rational function. Returns ------- alpha: array of scalars Coefficients. |
Gets the coefficients of the numerator of the rational function. Returns ------- alpha: array of scalars Coefficients. |
Gets the scaling parameters that define the matematical function. Returns ------- alpha: scalar (possibly complex) Inner scaling (argument). beta: scalar (possibly complex) Outer scaling (result). |
Gets the FN type of this object. Returns ------- type: `FN.Type` enumerate The inner product type currently being used.
|
Sets the two child functions that constitute this combined function, and the way they must be combined. Parameters ---------- comb: `FN.CombineType` enumerate How to combine the functions (addition, multiplication, division, composition). f1: FN First function. f2: FN Second function. |
Sets FN options from the options database. Notes ----- To see all options, run your program with the ``-help`` option.
|
Selects the method to be used to evaluate functions of matrices. Parameters ---------- meth: int An index indentifying the method. Notes ----- In some `FN` types there are more than one algorithms available for computing matrix functions. In that case, this function allows choosing the wanted method. If `meth` is currently set to 0 and the input argument of `FN.evaluateFunctionMat()` is a symmetric/Hermitian matrix, then the computation is done via the eigendecomposition, rather than with the general algorithm. |
Sets the prefix used for searching for all FN options in the database. Parameters ---------- prefix: string The prefix string to prepend to all FN option requests. Notes ----- A hyphen (``-``) must NOT be given at the beginning of the prefix name. The first character of all runtime options is AUTOMATICALLY the hyphen.
|
Selects the mode of operation in parallel runs. Parameters ---------- pmode: `FN.ParallelType` enumerate The parallel mode. |
Sets the index of the phi-function. Parameters ---------- k: int The index. |
Sets the coefficients of the denominator of the rational function. Parameters ---------- alpha: array of scalars Coefficients. |
Sets the coefficients of the numerator of the rational function. Parameters ---------- alpha: array of scalars Coefficients. |
Sets the scaling parameters that define the matematical function. Parameters ---------- alpha: scalar (possibly complex), optional Inner scaling (argument), default is 1.0. beta: scalar (possibly complex), optional Outer scaling (result), default is 1.0. |
Selects the type for the FN object. Parameters ---------- fn_type: `FN.Type` enumerate The inner product type to be used. |
Prints the FN data structure. Parameters ---------- viewer: Viewer, optional Visualization context; if not provided, the standard output is used.
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Mon Oct 4 12:32:48 2021 | http://epydoc.sourceforge.net |