FieldToPointConnection

class FieldToPointConnection(*args)

Composition function f \circ g where g acts on fields and f produces points.

Available constructors:

FieldToPointConnection(f_Function, g_FieldToPoint)

FieldToPointConnection(f_FieldToPoint, g_FieldFunction)

Parameters:

f_Function : Function

Function that acts on points and produces points

g_FieldFunction : FieldFunction

Function that acts on fields and produces fields

f_FieldToPoint, g_FieldToPoint : FieldToPointFunction

Function that acts on fields and produces points

Notes

This class is a particular case of the general class FieldToPointFunction. Thus it doesn’t implement the gradient nor the hessian.

Methods

__call__(…) <==> x(…)
getCallsNumber() Get the number of calls of the function.
getClassName() Accessor to the object’s name.
getFieldFunction() Accessor to the function g of class FieldFunction.
getFieldToPointFunction() Accessor to the function of class FieldToPointFunction.
getFunction() Accessor to the function f of class Function.
getId() Accessor to the object’s id.
getInputDescription() Get the description of the input field values.
getInputDimension() Get the dimension of the input field values.
getMarginal(*args) Get the marginal(s) at given indice(s).
getName() Accessor to the object’s name.
getOutputDescription() Get the description of the output vector.
getOutputDimension() Get the dimension of the output vector.
getShadowedId() Accessor to the object’s shadowed id.
getSpatialDimension() Get the dimension of the input domain.
getVisibility() Accessor to the object’s visibility state.
hasName() Test if the object is named.
hasVisibleName() Test if the object has a distinguishable name.
setInputDescription(inputDescription) Set the description of the input field values.
setName(name) Accessor to the object’s name.
setOutputDescription(outputDescription) Set the description of the output vector.
setShadowedId(id) Accessor to the object’s shadowed id.
setVisibility(visible) Accessor to the object’s visibility state.
__init__(*args)

x.__init__(…) initializes x; see help(type(x)) for signature

getCallsNumber()

Get the number of calls of the function.

Returns:

callsNumber : int

Counts the number of times the function has been called since its creation.

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

The object class name (object.__class__.__name__).

getFieldFunction()

Accessor to the function g of class FieldFunction.

Returns:

g : FieldFunction

The function f that acts on fields to produce fields.

getFieldToPointFunction()

Accessor to the function of class FieldToPointFunction.

Returns:

func : FieldToPointFunction

The function f or g that acts on fields to produce points.

getFunction()

Accessor to the function f of class Function.

Returns:

f : Function

The function f that acts on points to produce points.

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getInputDescription()

Get the description of the input field values.

Returns:

inputDescription : Description

Description of the input field values.

getInputDimension()

Get the dimension of the input field values.

Returns:

d : int

Dimension d of the input field values.

getMarginal(*args)

Get the marginal(s) at given indice(s).

Parameters:

i : int or list of ints, 0 \leq i < d

Indice(s) of the marginal(s) to be extracted.

Returns:

function : FieldToPointFunction

The initial function restricted to the concerned marginal(s) at the indice(s) i.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getOutputDescription()

Get the description of the output vector.

Returns:

outputDescription : Description

Description of the output vector.

getOutputDimension()

Get the dimension of the output vector.

Returns:

d’ : int

Dimension d' of the output vector.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getSpatialDimension()

Get the dimension of the input domain.

Returns:

spatialDim : int,

Dimension n of the input domain \cD.

getVisibility()

Accessor to the object’s visibility state.

Returns:

visible : bool

Visibility flag.

hasName()

Test if the object is named.

Returns:

hasName : bool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleName : bool

True if the name is not empty and not the default one.

setInputDescription(inputDescription)

Set the description of the input field values.

Parameters:

inputDescription : sequence of str

Description of the input field values.

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setOutputDescription(outputDescription)

Set the description of the output vector.

Parameters:

outputDescription : sequence of str

Description of the output vector.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

id : int

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visible : bool

Visibility flag.