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
ZdFunction3D Class Referenceabstract

#include <zd_function3d.hpp>

Inheritance diagram for ZdFunction3D:
ZdDocument ZdDocument ZqbAutoName ZqbAutoName ZqbAutoName ZqbAutoName ZqbName ZqbName ZqbName ZqbName ZqbName ZqbName ZqbName ZqbName ZdF3DMatrix< T > ZdF3DMatrix< T > ZdF3DSeismic ZdF3DSeismic

Public Member Functions

 ZdFunction3D (const char *szFuncName=NULL)
 
virtual ~ZdFunction3D ()
 
virtual bool compatibleType (const char *szType) const
 
virtual int countX ()=0
 
virtual int countY ()=0
 
virtual double argX (int iX)=0
 
virtual double argY (int iY)=0
 
virtual double func (int iX, int iY)=0
 
virtual void argX (std::vector< double > &vX)
 
virtual void argY (std::vector< double > &vY)
 
virtual bool isNullAll ()
 
virtual bool isNullFunc (int iX, int iY)
 
virtual double argStepX ()
 
virtual double argStepY ()
 
virtual void getArgBoundsX (double b[2])
 
virtual double minArgX ()
 
virtual double maxArgX ()
 
virtual void getArgBoundsY (double b[2])
 
virtual double minArgY ()
 
virtual double maxArgY ()
 
virtual void getFuncBounds (double b[2])
 
double minFunc ()
 
virtual double maxFunc ()
 
virtual int argIndexX (double x)
 
virtual int argIndexY (double y)
 
 ZdFunction3D (const char *szFuncName=NULL)
 
virtual ~ZdFunction3D ()
 
virtual bool compatibleType (const char *szType) const
 
virtual int countX ()=0
 
virtual int countY ()=0
 
virtual double argX (int iX)=0
 
virtual double argY (int iY)=0
 
virtual double func (int iX, int iY)=0
 
virtual void argX (std::vector< double > &vX)
 
virtual void argY (std::vector< double > &vY)
 
virtual bool isNullAll ()
 
virtual bool isNullFunc (int iX, int iY)
 
virtual double argStepX ()
 
virtual double argStepY ()
 
virtual void getArgBoundsX (double b[2])
 
virtual double minArgX ()
 
virtual double maxArgX ()
 
virtual void getArgBoundsY (double b[2])
 
virtual double minArgY ()
 
virtual double maxArgY ()
 
virtual void getFuncBounds (double b[2])
 
double minFunc ()
 
virtual double maxFunc ()
 
virtual int argIndexX (double x)
 
virtual int argIndexY (double y)
 
- 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 ()
 
ZqbName & operator= (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 ()
 
ZqbName & operator= (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 3D function implementation (z=f(x,y)) prepared in table format.

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

Constructor & Destructor Documentation

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

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

virtual ZdFunction3D::~ZdFunction3D ( )
virtual

Destroy the container.

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

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

virtual ZdFunction3D::~ZdFunction3D ( )
virtual

Destroy the container.

Member Function Documentation

virtual int ZdFunction3D::argIndexX ( double  x)
virtual

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

Reimplemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual int ZdFunction3D::argIndexX ( double  x)
virtual

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

Reimplemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual int ZdFunction3D::argIndexY ( double  y)
virtual

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

Reimplemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual int ZdFunction3D::argIndexY ( double  y)
virtual

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

Reimplemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual double ZdFunction3D::argStepX ( )
virtual

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

Reimplemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual double ZdFunction3D::argStepX ( )
virtual

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

Reimplemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual double ZdFunction3D::argStepY ( )
virtual

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

Reimplemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual double ZdFunction3D::argStepY ( )
virtual

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

Reimplemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual double ZdFunction3D::argX ( int  iX)
pure virtual

Get value of X argument in given point.

Implemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual double ZdFunction3D::argX ( int  iX)
pure virtual

Get value of X argument in given point.

Implemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual void ZdFunction3D::argX ( std::vector< double > &  vX)
virtual

Copy all values of X argument to given vector.

virtual void ZdFunction3D::argX ( std::vector< double > &  vX)
virtual

Copy all values of X argument to given vector.

virtual double ZdFunction3D::argY ( int  iY)
pure virtual

Get value of Y argument in given point.

Implemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual double ZdFunction3D::argY ( int  iY)
pure virtual

Get value of Y argument in given point.

Implemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual void ZdFunction3D::argY ( std::vector< double > &  vY)
virtual

Copy all values of Y argument to given vector.

virtual void ZdFunction3D::argY ( std::vector< double > &  vY)
virtual

Copy all values of Y argument to given vector.

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

Return true if given type is compatible with this document.

Reimplemented from ZdDocument.

Reimplemented in ZdF3DSeismic, and ZdF3DSeismic.

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

Return true if given type is compatible with this document.

Reimplemented from ZdDocument.

Reimplemented in ZdF3DSeismic, and ZdF3DSeismic.

virtual int ZdFunction3D::countX ( )
pure virtual

Get number of X points in function definition.

Implemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual int ZdFunction3D::countX ( )
pure virtual

Get number of X points in function definition.

Implemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual int ZdFunction3D::countY ( )
pure virtual

Get number of Y points in function definition.

Implemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual int ZdFunction3D::countY ( )
pure virtual

Get number of Y points in function definition.

Implemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual double ZdFunction3D::func ( int  iX,
int  iY 
)
pure virtual

Get value of function in given point - z=f(x,y). Returned value is undefined if function is not defined for this argument.

Implemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual double ZdFunction3D::func ( int  iX,
int  iY 
)
pure virtual

Get value of function in given point - z=f(x,y). Returned value is undefined if function is not defined for this argument.

Implemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual void ZdFunction3D::getArgBoundsX ( double  b[2])
virtual

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

Reimplemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual void ZdFunction3D::getArgBoundsX ( double  b[2])
virtual

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

Reimplemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual void ZdFunction3D::getArgBoundsY ( double  b[2])
virtual

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

Reimplemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual void ZdFunction3D::getArgBoundsY ( double  b[2])
virtual

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

Reimplemented in ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual void ZdFunction3D::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 ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual void ZdFunction3D::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 ZdF3DMatrix< T >, ZdF3DMatrix< T >, ZdF3DSeismic, and ZdF3DSeismic.

virtual bool ZdFunction3D::isNullAll ( )
virtual

Return true if all function values are empty and false otherwise. Very slow implementation because it scans the whole matrix countX()*countY().

Reimplemented in ZdF3DMatrix< T >, and ZdF3DMatrix< T >.

virtual bool ZdFunction3D::isNullAll ( )
virtual

Return true if all function values are empty and false otherwise. Very slow implementation because it scans the whole matrix countX()*countY().

Reimplemented in ZdF3DMatrix< T >, and ZdF3DMatrix< T >.

virtual bool ZdFunction3D::isNullFunc ( int  iX,
int  iY 
)
virtual

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

Reimplemented in ZdF3DMatrix< T >, and ZdF3DMatrix< T >.

virtual bool ZdFunction3D::isNullFunc ( int  iX,
int  iY 
)
virtual

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

Reimplemented in ZdF3DMatrix< T >, and ZdF3DMatrix< T >.

virtual double ZdFunction3D::maxArgX ( )
inlinevirtual

Return maximum value of X argument.

virtual double ZdFunction3D::maxArgX ( )
inlinevirtual

Return maximum value of X argument.

virtual double ZdFunction3D::maxArgY ( )
inlinevirtual

Return maximum value of Y argument.

virtual double ZdFunction3D::maxArgY ( )
inlinevirtual

Return maximum value of Y argument.

virtual double ZdFunction3D::maxFunc ( )
inlinevirtual

Return maximum value of function.

virtual double ZdFunction3D::maxFunc ( )
inlinevirtual

Return maximum value of function.

virtual double ZdFunction3D::minArgX ( )
inlinevirtual

Return minimum value of X argument.

virtual double ZdFunction3D::minArgX ( )
inlinevirtual

Return minimum value of X argument.

virtual double ZdFunction3D::minArgY ( )
inlinevirtual

Return minimum value of Y argument.

virtual double ZdFunction3D::minArgY ( )
inlinevirtual

Return minimum value of Y argument.

double ZdFunction3D::minFunc ( )
inline

Return minimum value of function.

double ZdFunction3D::minFunc ( )
inline

Return minimum value of function.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.5