MultiLinearScalarFunction Class Reference

#include <ScalarFunctionsImpl.h>

Inheritance diagram for MultiLinearScalarFunction:

Collaboration diagram for MultiLinearScalarFunction:

Public Member Functions
	MultiLinearScalarFunction (const std::vector< doublereal > &y_i, const std::vector< doublereal > &x_i, bool doNotExtrapolate=false)
virtual	~MultiLinearScalarFunction (void)
virtual doublereal	operator() (const doublereal x) const
virtual doublereal	ComputeDiff (const doublereal t, const integer order=1) const
Public Member Functions inherited from DifferentiableScalarFunction
virtual	~DifferentiableScalarFunction ()
Public Member Functions inherited from BasicScalarFunction
virtual	~BasicScalarFunction ()

Private Attributes
std::vector< doublereal >	Y_i
std::vector< doublereal >	X_i
bool	doNotExtrapolate

Detailed Description

Definition at line 136 of file ScalarFunctionsImpl.h.

Constructor & Destructor Documentation

MultiLinearScalarFunction::MultiLinearScalarFunction	(	const std::vector< doublereal > &	y_i,
		const std::vector< doublereal > &	x_i,
		bool	doNotExtrapolate = false
	)

Definition at line 557 of file ScalarFunctionsImpl.cc.

References ASSERTMSGBREAK, MBDYN_EXCEPT_ARGS, X_i, and Y_i.

: Y_i(y_i), X_i(x_i),
doNotExtrapolate(doNotExtrapolate)
{
        ASSERTMSGBREAK(X_i.size() == Y_i.size(),
                "MultiLinearScalarFunction error, Y_i.size() != X_i.size()");
        std::vector<doublereal>::iterator xi, xe;
        xi = X_i.begin();
        xe = X_i.end()-1;
        for (unsigned i = 0; xi != xe; ++xi, ++i) {
                if (*xi >= *(xi + 1)) {
                        silent_cerr("MultiLinearScalarFunction error, "
                                "X is not ordered: "
                                "X[" << i << "]=" << *xi
                                << " is not less than "
                                "X[" << i + 1 << "]=" << *(xi + 1)
                                << std::endl);
                        throw DataManager::ErrGeneric(MBDYN_EXCEPT_ARGS);
                }
        }
}

MultiLinearScalarFunction::~MultiLinearScalarFunction ( void  )

virtual

Definition at line 582 of file ScalarFunctionsImpl.cc.

References NO_OP.

{
        NO_OP;
}

Member Function Documentation

doublereal MultiLinearScalarFunction::ComputeDiff ( const doublereal  t, const integer  order = 1  ) const

virtual

Implements DifferentiableScalarFunction.

Definition at line 605 of file ScalarFunctionsImpl.cc.

References ASSERTMSGBREAK, leval(), operator()(), X_i, and Y_i.

{
        ASSERTMSGBREAK(order >=0, "Error in MultiLinearScalarFunction::ComputeDiff, order<0");
        switch (order) {
        case 0: 
                return operator()(x);

        case 1: 
                return leval(x, X_i, Y_i, order);

        default:
                return 0.;
        }
}

Here is the call graph for this function:

doublereal MultiLinearScalarFunction::operator() ( const doublereal  x ) const

virtual

Implements DifferentiableScalarFunction.

Definition at line 588 of file ScalarFunctionsImpl.cc.

References doNotExtrapolate, leval(), X_i, and Y_i.

Referenced by ComputeDiff().

{
        if (doNotExtrapolate) {
                if (x <= X_i[0]) {
                        return Y_i[0];
                }
                
                int s = X_i.size() - 1;
                if (x >= X_i[s]) {
                        return Y_i[s];
                }
        }

        return leval(x, X_i, Y_i);
}

Here is the call graph for this function:

Member Data Documentation

bool MultiLinearScalarFunction::doNotExtrapolate

private

Definition at line 140 of file ScalarFunctionsImpl.h.

Referenced by operator()().

std::vector<doublereal> MultiLinearScalarFunction::X_i

private

Definition at line 139 of file ScalarFunctionsImpl.h.

Referenced by ComputeDiff(), MultiLinearScalarFunction(), and operator()().

std::vector<doublereal> MultiLinearScalarFunction::Y_i

private

Definition at line 138 of file ScalarFunctionsImpl.h.

Referenced by ComputeDiff(), MultiLinearScalarFunction(), and operator()().

---

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

• ScalarFunctionsImpl.h
• ScalarFunctionsImpl.cc