concepts.dm.crow.crow_function.CrowFunction#

class CrowFunction[source]#

Bases: CrowFunctionBase

Methods

`flags`([short])	Return the flags of the function.
`from_function`(function[, implementation, sig])	Create a function object from an actual Python function.
`get_overridden_call`([ftype_index])	Get the overridden call function.
`get_sub_function`(ftype_index)
`mark_static`([flag])	Mark a predicate as static (i.e., its grounded value will never change).
`partial`(*args[, execute_fully_bound_functions])
`remap_arguments`(remapping)	Generate a new Function object with a different argument order.
`set_function_body`(function_body)	Set the function body.
`set_function_name`(function_name)	Set the function name.

Attributes

`all_sub_functions`
`arguments`
`is_execution_dependent`	Whether the function is execution-dependent.
`is_feature`	Whether the object is defined as a state feature.
`is_function`	Whether the object is defined as a function.
`is_generator_function`
`is_overloaded`	Return True if the function is overloaded.
`is_simulation_dependent`	Whether the function is simulation-dependent.
`nr_arguments`
`return_type`
`is_static`	Whether the function is static (i.e., its grounded value will never change).
`is_cacheable`	Whether the function can be cached.
`evaluation_mode`	The evaluation mode of the function.
`is_generator_placeholder`	Whether the function is a generator placeholder.
`inplace_generators`	The list of inplace generators.
`is_sgc_function`	Whether the function is a SGC (state-goal-constraint) function.

__call__(*args, **kwargs)#: Call self as a function.

__init__(name, ftype, derived_expression=None, generator_placeholder=False, inplace_generators=None, sgc=False, simulation=False, execution=False)[source]#

Initialize the Crow function.

Parameters:

name (str) – the name of the function.
ftype (FunctionType) – the type of the function.
derived_expression (ValueOutputExpression | None) – an optional derived expression of the function.
generator_placeholder (bool)
inplace_generators (Sequence[str] | None)
sgc (bool)
simulation (bool)
execution (bool)

__new__(**kwargs)#

flags(short=False)[source]#

Return the flags of the function.

Parameters:: short (bool)
Return type:: Dict[str, bool]

classmethod from_function(function, implementation=True, sig=None)#

Create a function object from an actual Python function.

Parameters:

function (Callable) – The function.
implementation (bool) – Whether the function is an implementation. Defaults to True.
sig (Signature | None) – The signature of the function. Defaults to None.

get_overridden_call(ftype_index=None)#

Get the overridden call function.

Parameters:: ftype_index (int | None)
Return type:: Callable | None

get_sub_function(ftype_index)#

Parameters:: ftype_index (int)
Return type:: Function

mark_static(flag=True)#

Mark a predicate as static (i.e., its grounded value will never change).

Parameters:: flag (bool) – Whether to mark the predicate as static.

partial(*args, execute_fully_bound_functions=False, **kwargs)#

Return type:: Function | FunctionApplicationExpression

remap_arguments(remapping)#

Generate a new Function object with a different argument order. Specifically, remapping is a permutation. The i-th argument to the new function will be the remapping[i]-th argument in the old function.

Parameters:: remapping (List[int]) – The remapping.
Returns:: The new function.
Return type:: Function

set_function_body(function_body)#

Set the function body.

Parameters:: function_body (Callable)

set_function_name(function_name)#

Set the function name.

Parameters:: function_name (str)

property all_sub_functions#

property arguments: Tuple[Variable]#

evaluation_mode: CrowFunctionEvaluationMode#: The evaluation mode of the function. This enum has three values:

inplace_generators: Tuple[str, ...]#: The list of inplace generators. This is usually used together with generator-placeholder functions.

is_cacheable: bool#: Whether the function can be cached. Specifically, if it contains only “ObjectTypes” as arguments, it can be statically evaluated.

property is_execution_dependent: bool#: Whether the function is execution-dependent.

property is_feature: bool#: Whether the object is defined as a state feature.

property is_function: bool#: Whether the object is defined as a function.

property is_generator_function: bool#

is_generator_placeholder: bool#: Whether the function is a generator placeholder.

property is_overloaded: bool#: Return True if the function is overloaded.

is_sgc_function: bool#: Whether the function is a SGC (state-goal-constraint) function.

property is_simulation_dependent: bool#: Whether the function is simulation-dependent.

is_static: bool#: Whether the function is static (i.e., its grounded value will never change).

property nr_arguments: int#

property return_type: ObjectType | ValueType | FunctionType | SequenceType#