Package parsimony :: Package functions :: Package multiblock :: Module properties :: Class MultiblockFunction

Class MultiblockFunction

              object --+        
                       |        
     properties.Function --+    
                           |    
properties.CompositeFunction --+
                               |
                              MultiblockFunction

Known Subclasses:

This is a function that is the combination (i.e. sum) of other multiblock, composite or atomic functions. The difference from CompositeFunction is that this function assumes that relevant functions accept an index, i, that is the block we are working with.

Instance Methods

[hide private]

add_constraint(self, function, index)
Add a constraint to this function.

source code

get_constraints(self, index)
Returns the constraint functions for the function with the given index.

source code

Inherited from properties.Function: f, get_params, reset, set_params

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

__metaclass__ = abc.ABCMeta
Metaclass for defining Abstract Base Classes (ABCs).

constraints = {}

Inherited from properties.Function: __abstractmethods__

Inherited from properties.Function (private): _abc_cache, _abc_negative_cache, _abc_negative_cache_version, _abc_registry

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

get_constraints(self, index)

source code

Returns the constraint functions for the function with the given index. Returns an empty list if no constraint functions exist for the given index.