UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | List of all members
ZdFunction Class Referenceabstract

#include <zd_function.hpp>

Inheritance diagram for ZdFunction:
ZdDocument ZdDocument ZqbAutoName ZqbAutoName ZqbAutoName ZqbAutoName ZqbName ZqbName ZqbName ZqbName ZqbName ZqbName ZqbName ZqbName ZdFVector< T > ZdFVector< T > ZdRealFunc ZdRealFunc ZdTrace ZdTrace

Public Member Functions

 ZdFunction (const char *szFuncName=NULL)
 
virtual ~ZdFunction ()
 
virtual bool compatibleType (const char *szType) const
 
virtual int count ()=0
 
virtual double arg (int i)=0
 
virtual double func (int i)=0
 
virtual void arg (std::vector< double > &vArg)
 
virtual void func (std::vector< double > &vFunc, double fNull=0.0)
 
virtual bool isNullAll ()
 
virtual bool isNullFunc (int i)
 
virtual double argStep ()
 
virtual void getArgBounds (double b[2])
 
virtual double minArg ()
 
virtual double maxArg ()
 
virtual void getFuncBounds (double b[2])
 
double minFunc ()
 
virtual double maxFunc ()
 
virtual int argIndex (double a)
 
virtual double funcInterp (double a)
 
virtual void setFunc (int i, double fNewValue)
 
virtual void makeNullFunc (int i)
 
virtual void makeNullAll ()
 
 ZdFunction (const char *szFuncName=NULL)
 
virtual ~ZdFunction ()
 
virtual bool compatibleType (const char *szType) const
 
virtual int count ()=0
 
virtual double arg (int i)=0
 
virtual double func (int i)=0
 
virtual void arg (std::vector< double > &vArg)
 
virtual void func (std::vector< double > &vFunc, double fNull=0.0)
 
virtual bool isNullAll ()
 
virtual bool isNullFunc (int i)
 
virtual double argStep ()
 
virtual void getArgBounds (double b[2])
 
virtual double minArg ()
 
virtual double maxArg ()
 
virtual void getFuncBounds (double b[2])
 
double minFunc ()
 
virtual double maxFunc ()
 
virtual int argIndex (double a)
 
virtual double funcInterp (double a)
 
virtual void setFunc (int i, double fNewValue)
 
virtual void makeNullFunc (int i)
 
virtual void makeNullAll ()
 
- Public Member Functions inherited from ZdDocument
 ZdDocument (const char *szName=NULL)
 
virtual ~ZdDocument ()
 
virtual void updateViews ()
 
virtual bool isChanged ()
 
virtual void setChanges ()
 
virtual void resetChanges ()
 
 ZdDocument (const char *szName=NULL)
 
virtual ~ZdDocument ()
 
virtual void updateViews ()
 
virtual bool isChanged ()
 
virtual void setChanges ()
 
virtual void resetChanges ()
 
- Public Member Functions inherited from ZqbAutoName
 ZqbAutoName (int *pCounter, const char *szRoot, const char *szCustomName=NULL)
 
virtual ~ZqbAutoName ()
 
 ZqbAutoName (int *pCounter, const char *szRoot, const char *szCustomName=NULL)
 
virtual ~ZqbAutoName ()
 
- Public Member Functions inherited from ZqbName
 ZqbName (const char *szRoot, const char *szCustomName=NULL)
 
 ZqbName (const ZqbName &name)
 
virtual ~ZqbName ()
 
ZqbNameoperator= (const ZqbName &name)
 
virtual const char * getName () const
 
virtual const char * getType () const
 
bool hasName (const char *szString) const
 
 ZqbName (const char *szRoot, const char *szCustomName=NULL)
 
 ZqbName (const ZqbName &name)
 
virtual ~ZqbName ()
 
ZqbNameoperator= (const ZqbName &name)
 
virtual const char * getName () const
 
virtual const char * getType () const
 
bool hasName (const char *szString) const
 

Additional Inherited Members

- Protected Attributes inherited from ZdDocument
ZqbViewVector m_Views
 
- Protected Attributes inherited from ZqbName
char * m_szName
 
char * m_szRoot
 

Detailed Description

Abstract class for arbitrary function implementation prepared in table format.

Doc/View conception is supported. Ambiguous functions may be implemented as well.

Constructor & Destructor Documentation

ZdFunction::ZdFunction ( const char *  szFuncName = NULL)

Create empty function container with given name (actually, pure virtual methods prohibit creation of class instances).

virtual ZdFunction::~ZdFunction ( )
virtual

Destroy the container.

ZdFunction::ZdFunction ( const char *  szFuncName = NULL)

Create empty function container with given name (actually, pure virtual methods prohibit creation of class instances).

virtual ZdFunction::~ZdFunction ( )
virtual

Destroy the container.

Member Function Documentation

virtual double ZdFunction::arg ( int  i)
pure virtual

Get value of argument in given point.

Implemented in ZdFVector< T >, ZdFVector< T >, ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual double ZdFunction::arg ( int  i)
pure virtual

Get value of argument in given point.

Implemented in ZdFVector< T >, ZdFVector< T >, ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual void ZdFunction::arg ( std::vector< double > &  vArg)
virtual

Copy all values of the argument to given vector.

virtual void ZdFunction::arg ( std::vector< double > &  vArg)
virtual

Copy all values of the argument to given vector.

virtual int ZdFunction::argIndex ( double  a)
virtual

Return index of argument the most close to given value. Complexity of default implementation is O(N) where N is number of points.

Reimplemented in ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual int ZdFunction::argIndex ( double  a)
virtual

Return index of argument the most close to given value. Complexity of default implementation is O(N) where N is number of points.

Reimplemented in ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual double ZdFunction::argStep ( )
virtual

Return step of argument in case argument has uniform step and 0 otherwise. Default implementation returns 0.

Reimplemented in ZdFVector< T >, ZdFVector< T >, ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual double ZdFunction::argStep ( )
virtual

Return step of argument in case argument has uniform step and 0 otherwise. Default implementation returns 0.

Reimplemented in ZdFVector< T >, ZdFVector< T >, ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual bool ZdFunction::compatibleType ( const char *  szType) const
virtual

Return true if given type is compatible with this document.

Reimplemented from ZdDocument.

Reimplemented in ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual bool ZdFunction::compatibleType ( const char *  szType) const
virtual

Return true if given type is compatible with this document.

Reimplemented from ZdDocument.

Reimplemented in ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual int ZdFunction::count ( )
pure virtual

Get number of points in function definition.

Implemented in ZdFVector< T >, ZdFVector< T >, ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual int ZdFunction::count ( )
pure virtual

Get number of points in function definition.

Implemented in ZdFVector< T >, ZdFVector< T >, ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual double ZdFunction::func ( int  i)
pure virtual

Get value of function in given point. Returned value is undefined if function is not defined for this argument.

Implemented in ZdFVector< T >, ZdFVector< T >, ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual double ZdFunction::func ( int  i)
pure virtual

Get value of function in given point. Returned value is undefined if function is not defined for this argument.

Implemented in ZdFVector< T >, ZdFVector< T >, ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual void ZdFunction::func ( std::vector< double > &  vFunc,
double  fNull = 0.0 
)
virtual

Copy all values of the function to given vector. Since some values which are null (isNullFunc() returns true for them) replaced by given "null" value (zero by default).

virtual void ZdFunction::func ( std::vector< double > &  vFunc,
double  fNull = 0.0 
)
virtual

Copy all values of the function to given vector. Since some values which are null (isNullFunc() returns true for them) replaced by given "null" value (zero by default).

virtual double ZdFunction::funcInterp ( double  a)
virtual

Return interpolation of the function in given argument. Default implementation performs linear interpolation of function value in range [argIndex(),argIndex()+1] or [argIndex()-1,argIndex()]. Complexity of default implementation is O(N) where N is number of points.

Reimplemented in ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual double ZdFunction::funcInterp ( double  a)
virtual

Return interpolation of the function in given argument. Default implementation performs linear interpolation of function value in range [argIndex(),argIndex()+1] or [argIndex()-1,argIndex()]. Complexity of default implementation is O(N) where N is number of points.

Reimplemented in ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual void ZdFunction::getArgBounds ( double  b[2])
virtual

Return minimum and maximum values for argument. Default implementation calculates minimum and maximum values in cycle. If number of points is zero then {0,0} is returned.

Reimplemented in ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual void ZdFunction::getArgBounds ( double  b[2])
virtual

Return minimum and maximum values for argument. Default implementation calculates minimum and maximum values in cycle. If number of points is zero then {0,0} is returned.

Reimplemented in ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual void ZdFunction::getFuncBounds ( double  b[2])
virtual

Return minimum and maximum values for function. Default implementation calculates minimum and maximum values in cycle. If number of points is zero or there is no points with defined value then {0,0} is returned.

Reimplemented in ZdRealFunc, and ZdRealFunc.

virtual void ZdFunction::getFuncBounds ( double  b[2])
virtual

Return minimum and maximum values for function. Default implementation calculates minimum and maximum values in cycle. If number of points is zero or there is no points with defined value then {0,0} is returned.

Reimplemented in ZdRealFunc, and ZdRealFunc.

virtual bool ZdFunction::isNullAll ( )
virtual

Return true if all function values are empty and false otherwise.

Reimplemented in ZdRealFunc, and ZdRealFunc.

virtual bool ZdFunction::isNullAll ( )
virtual

Return true if all function values are empty and false otherwise.

Reimplemented in ZdRealFunc, and ZdRealFunc.

virtual bool ZdFunction::isNullFunc ( int  i)
virtual

Return false if function's value is defined and true otherwise. Returns false in default implementation.

Reimplemented in ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual bool ZdFunction::isNullFunc ( int  i)
virtual

Return false if function's value is defined and true otherwise. Returns false in default implementation.

Reimplemented in ZdRealFunc, ZdRealFunc, ZdTrace, and ZdTrace.

virtual void ZdFunction::makeNullAll ( )
virtual

Make all function values to be null. Not implemented!

Reimplemented in ZdRealFunc, and ZdRealFunc.

virtual void ZdFunction::makeNullAll ( )
virtual

Make all function values to be null. Not implemented!

Reimplemented in ZdRealFunc, and ZdRealFunc.

virtual void ZdFunction::makeNullFunc ( int  i)
virtual

Make the function value in given point to be null. Not implemented!

Reimplemented in ZdRealFunc, and ZdRealFunc.

virtual void ZdFunction::makeNullFunc ( int  i)
virtual

Make the function value in given point to be null. Not implemented!

Reimplemented in ZdRealFunc, and ZdRealFunc.

virtual double ZdFunction::maxArg ( )
inlinevirtual

Return maximum value of argument.

virtual double ZdFunction::maxArg ( )
inlinevirtual

Return maximum value of argument.

virtual double ZdFunction::maxFunc ( )
inlinevirtual

Return maximum value of function.

virtual double ZdFunction::maxFunc ( )
inlinevirtual

Return maximum value of function.

virtual double ZdFunction::minArg ( )
inlinevirtual

Return minimum value of argument.

virtual double ZdFunction::minArg ( )
inlinevirtual

Return minimum value of argument.

double ZdFunction::minFunc ( )
inline

Return minimum value of function.

double ZdFunction::minFunc ( )
inline

Return minimum value of function.

virtual void ZdFunction::setFunc ( int  i,
double  fNewValue 
)
virtual

Assign new value to the function. Not implemented!

Reimplemented in ZdFVector< T >, ZdFVector< T >, ZdRealFunc, and ZdRealFunc.

virtual void ZdFunction::setFunc ( int  i,
double  fNewValue 
)
virtual

Assign new value to the function. Not implemented!

Reimplemented in ZdFVector< T >, ZdFVector< T >, ZdRealFunc, and ZdRealFunc.


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