Home | Trees | Indices | Help |
|
---|
|
FN
|
|||
CombineType FN type of combination of child functions |
|||
Type FN type |
|
|||
a new object with type S, a subtype of T |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from |
|
|||
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.
|
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). |
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 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.
|
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.
|
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) inner scaling (argument). beta: scalar (possibly complex) outer scaling (result). |
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 Wed Oct 14 09:49:44 2020 | http://epydoc.sourceforge.net |