Home       Trees       Indices       Help   
Package parsimony :: Package functions :: Package multiblock :: Module losses :: Class GeneralisedMultiblock
[hide private]
[frames] | no frames]

Class GeneralisedMultiblock

source code

                     object --+            
                              |            
            properties.Function --+        
                                  |        
       properties.CompositeFunction --+    
                                      |    
          properties.MultiblockFunction --+
                                          |
                             object --+   |
                                      |   |
          properties.MultiblockGradient --+
                                          |
                             object --+   |
                                      |   |
properties.MultiblockProjectionOperator --+
                                          |
                             object --+   |
                                      |   |
                    properties.StepSize --+
                                          |
                                         GeneralisedMultiblock
Instance Methods [hide private]
 
__init__(self, X, functions)
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
 
reset(self)
Free any cached computations from previous use of this Function.		 source code
 
f(self, w)
Function value.		 source code
 
grad(self, w, index)
Gradient of the differentiable part of the function.		 source code
 
proj(self, w, index)
The projection operator corresponding to the function with the index.		 source code
 
step(self, w, index)
The step size to use in descent methods.		 source code

Inherited from properties.MultiblockFunction: add_constraint, get_constraints

Inherited from properties.Function: get_params, set_params

Inherited from properties.MultiblockGradient: approx_grad

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

Class Variables [hide private]
  __abstractmethods__ = frozenset([])
  _abc_negative_cache_version = 14

Inherited from properties.MultiblockFunction: __metaclass__, constraints

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, X, functions)
(Constructor)

source code 

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

Overrides: object.__init__
(inherited documentation)

reset(self)

source code 

Free any cached computations from previous use of this Function.

Overrides: properties.Function.reset
(inherited documentation)

f(self, w)

source code 

Function value.

Overrides: properties.Function.f

grad(self, w, index)

source code 

Gradient of the differentiable part of the function.

From the interface "MultiblockGradient".

Overrides: properties.MultiblockGradient.grad

proj(self, w, index)

source code 

The projection operator corresponding to the function with the index.

From the interface "MultiblockProjectionOperator".

Overrides: properties.MultiblockProjectionOperator.proj

step(self, w, index)

source code  
The step size to use in descent methods.

Parameters
----------
beta : Numpy array. The point at which to determine the step size.

index : Non-negative integer. For multiblock functions, to know which
        variable the step is for.
Overrides: properties.StepSize.step
(inherited documentation)

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Mon Apr 6 23:52:11 2015 http://epydoc.sourceforge.net