pyCAPS
pyCAPS: A Python Extension Module for CAPS
Loading...
Searching...
No Matches
ValueOut Class Reference

Defines a CAPS output Value Object Not a standalone class. More...

Inherits object.

Public Member Functions

 value (self)
 Property getter returns a copy the values stored in the CAPS Value Object.
 
 name (self)
 Property returns the name of the CAPS Value Object.
 
 history (self)
 Returns the history list of the CAPS Value Object.
 
 props (self)
 Property getter returns a copy the values stored in the CAPS Value Object.
 
 hasDeriv (self)
 Returns a string list of of the input Value Object names that can be used in deriv.
 
 deriv (self, name=None)
 Returns derivatives of the output Value Object.
 

Detailed Description

Defines a CAPS output Value Object Not a standalone class.

Member Function Documentation

◆ deriv()

deriv (   self,
  name = None 
)

Returns derivatives of the output Value Object.

Parameters
nameName of the input Value Object to take derivative w.r.t. if name is None then a dictionary with all dervatives from hasDeriv are returned

The documentation for this class was generated from the following file: