VedaLibMath/EquationList.h

Go to the documentation of this file.

/*! \file 
    \author victorien ferry & www.m4nkind.com
    \brief This file applies the GNU LESSER GENERAL PUBLIC LICENSE Version 2.1 , read file COPYING.
*/
#ifndef COM_M4NKIND_EquationList_H
#define COM_M4NKIND_EquationList_H

#include "VirtualEquation.h"
#include "PackFloat.h"
#include "PackStruct.h"
#include "PackULong_Enums.h"
#include "PackULong_Flags.h"
#include "PackDynamicFloat.h"
#include "PackList.h"

/*!
    \class  EquationList
    \ingroup BaseObjectInherited_VedaLibMath BaseObjectInheritedDocGroup
    \brief  Able to compute an equation according to a list of operators.
*/
class EquationList : public VirtualEquation
{
/*==================================================================
                                PUBLIC
==================================================================*/
public:
    /*!
        \brief  Constructor. There should only be members initialisation there.
    */
    EquationList(void);

    /*!
        \brief  Class Inheritance Descriptors. Also forces a destructor. See BASEOBJECT_DECLARE_... in .cpp
    */
    BASEOBJECT_DEFINE_CLASS(EquationList);

    /*!
        \brief   Compute a scalar value according to a parameter list (X,Y,Z,D).
        \param  _OutgoingParameterTable result table. elements are writen or not according to the equation.
        \param _IncomingParameterTable. float table, the (X,Y,Z,D) parameters.
    */
    virtual void Compute( float _OutgoingParameterTable[4] , const float _IncomingParameterTable[4] );

/*==================================================================
                                PROTECTED
==================================================================*/
protected:

    //! the equation line list:
    PackList    mSer_EquationList;
    /*!
        \brief  just use CreateInternal() to return an error in some case...
        no use in other cases...
    */
    //virtual bool CreateInternal(void);
    /*!
        \brief   enum of the available Variables    
    */
    typedef enum  {
        eEqu_Var_Input=0,
        eEqu_Var_Result,
        eEqu_Var_A,
        eEqu_Var_B,
        eEqu_Var_C,
        eEqu_Var_D,
        eEqu_Var_E,
        eEqu_Var_F,
        eEqu_Var_G,
        eEqu_Var_H,
        eEqu_Var_NumberOfVar
    };
    /*!
        \brief   enum of the available operators    
    */
    typedef enum  {
        eEquOp_Equal=0,
        eEquOp_Add,
        eEquOp_Sub,
        eEquOp_Mul,
        eEquOp_Div,
        eEquOp_Ceiling,
        eEquOp_Floor,
        eEquOp_Sin,
        eEquOp_Cos,
        eEquOp_MulSin,
        eEquOp_MulCos,
        eEquOp_AddSin,
        eEquOp_AddCos,
        eEquOp_Sqrt
    };
    /*!
        \brief   Nested class used for operand combo,patching PackDynamicFloat.
    */
    class OperandType  : public PackDynamicType
    { public:
        //! constructor, add member:
        OperandType();
        PackULong_Enums     mSer_Variables;
        PackDynamicFloat    mSer_Vector;
    };
    /*!
        \brief   Nested class that describes a reference to an object3D, used as element in the list.
    */
    class EquationLine : public PackStruct
    {
    public:
        //! \brief constructor . It registers the members:
        EquationLine(void);
        //! the variable touch:
        PackULong_Enums mSer_AffectedVarEnum;
        //! which XYZT is affected
        PackULong_Enums mSer_AffectedDimension;
        //! type of affectation, =,+=,-=,*=,/=
        //PackULong_Enums   mSer_DoOperator;
        //! the operator identifier:
        PackULong_Enums mSer_OperatorEnum;
        //! which XYZT is used in operand
        PackULong_Enums mSer_OperandDimension;
        //! operand:
        OperandType mSer_Operand;
        //! precalculation:
        //char m_AffectedToOperandIndex[4];
    };
    
    /*!
        \brief  static method passed to the list to create new elements.
        \return a new MathOperator object.
    */
    static BaseType *NewEquationLine();
    
    static  void    Op_Equal(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);
    static  void    Op_Add(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);
    static  void    Op_Sub(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);
    static  void    Op_Mul(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);
    static  void    Op_Div(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);
    static  void    Op_Ceiling(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);
    static  void    Op_Floor(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);
    static  void    Op_CosSin(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);
    static  void    Op_AddCosSin(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);
    static  void    Op_MulCosSin(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);
    static  void    Op_Random(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);
    static  void    Op_Norm(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);

    //static    void    Op_Sqrt(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);

    //! function table to execute the operators by index.
    static void (*m_Op_FunctionTable[])(float *_pAffect,unsigned int _nbAffect,float *_pOperand,unsigned int _nbOp);


};
#endif

---

      /\/\        4         N         k         !         N         D
                      _______  _ __ ___  _____            ___ _ _  ____
     ___________  __//___   /________  |/    / ___________\_______/    \
    /   _   _   \/   _     /    _   /      _/_/____/    _       __     /
   /    /   /       /     /    /    \      \/     /    /    \   \     /
  \\___/___/___/    ¯    _____/_____/       ______\___/_____/\________\\
               \________/_ ___ __ l____\      /elD!  
                 http://www.m4nkind.com \____/