A multivariate polynomial function. More...

Inheritance diagram for OpenSim::MultivariatePolynomialFunction:

OpenSim Properties, Sockets, Outputs, Inputs
Properties (single-value)
SimTK::Vector	coefficients
	"Coefficients of a multivariate polynomial function in order of" " ascending powers starting from the last dependent component." More...

int	dimension
	"Number of input dimensions (i.e., dependent components)." More...

int	order
	"The largest sum of exponents in a single term." More...

Public Member Functions
	MultivariatePolynomialFunction ()

	MultivariatePolynomialFunction (SimTK::Vector coefficients, int dimension, int order)

void	setCoefficients (SimTK::Vector coefficients)
	Set coefficients. More...

const SimTK::Vector &	getCoefficients () const
	Get coefficients. More...

void	setDimension (int dimension)
	Set dimension. More...

int	getDimension () const
	Get dimension. More...

void	setOrder (int order)
	Set order (largest sum of exponents in a single term). More...

int	getOrder () const
	Get order. More...

SimTK::Function *	createSimTKFunction () const override
	Return function. More...

Property-related functions
const SimTK::Vector &	get_coefficients () const
	Get the value of the coefficients property. More...

SimTK::Vector &	upd_coefficients ()
	Get a writable reference to the coefficients property. More...

void	set_coefficients (const SimTK::Vector &value)
	Set the value of the coefficients property. More...

const int &	get_dimension () const
	Get the value of the dimension property. More...

int &	upd_dimension ()
	Get a writable reference to the dimension property. More...

void	set_dimension (const int &value)
	Set the value of the dimension property. More...

const int &	get_order () const
	Get the value of the order property. More...

int &	upd_order ()
	Get a writable reference to the order property. More...

void	set_order (const int &value)
	Set the value of the order property. More...

Public Member Functions inherited from OpenSim::Function
	Function ()

	Function (const Function &aFunction)

virtual	~Function ()

virtual void	init (Function *aFunction)

Function &	operator= (const Function &aFunction)

virtual double	calcValue (const SimTK::Vector &x) const
	Calculate the value of this function at a particular point. More...

virtual double	calcDerivative (const std::vector< int > &derivComponents, const SimTK::Vector &x) const
	Calculate a partial derivative of this function at a particular point. More...

virtual int	getArgumentSize () const
	Get the number of components expected in the input vector. More...

virtual int	getMaxDerivativeOrder () const
	Get the maximum derivative order this Function object can calculate. More...

Public Member Functions inherited from OpenSim::Object
virtual	~Object ()
	Virtual destructor for cleanup. More...

bool	isEqualTo (const Object &aObject) const
	Equality operator wrapper for use from languages not supporting operator overloading. More...

Object &	operator= (const Object &aObject)
	Copy assignment copies he base class fields, including the properties. More...

virtual bool	operator== (const Object &aObject) const
	Determine if two objects are equal. More...

virtual bool	operator< (const Object &aObject) const
	Provide an ordering for objects so they can be put in sorted containers. More...

void	setName (const std::string &name)
	Set the name of the Object. More...

const std::string &	getName () const
	Get the name of this Object. More...

void	setDescription (const std::string &description)
	Set description, a one-liner summary. More...

const std::string &	getDescription () const
	Get description, a one-liner summary. More...

const std::string &	getAuthors () const
	Get Authors of this Object. More...

void	setAuthors (const std::string &authors)
	Set Authors of this object. More...

const std::string &	getReferences () const
	Get references or publications to cite if using this object. More...

void	setReferences (const std::string &references)
	Set references or publications to cite if using this object. More...

int	getNumProperties () const
	Determine how many properties are stored with this Object. More...

const AbstractProperty &	getPropertyByIndex (int propertyIndex) const
	Get a const reference to a property by its index number, returned as an AbstractProperty. More...

AbstractProperty &	updPropertyByIndex (int propertyIndex)
	Get a writable reference to a property by its index number, returned as an AbstractProperty. More...

bool	hasProperty (const std::string &name) const
	Return true if this Object has a property of any type with the given name, which must not be empty. More...

const AbstractProperty &	getPropertyByName (const std::string &name) const
	Get a const reference to a property by its name, returned as an AbstractProperty. More...

AbstractProperty &	updPropertyByName (const std::string &name)
	Get a writable reference to a property by its name, returned as an AbstractProperty. More...

template<class T >
bool	hasProperty () const
	Return true if this Object contains an unnamed, one-object property that contains objects of the given template type T. More...

template<class T >
const Property< T > &	getProperty (const PropertyIndex &index) const
	Get property of known type Property<T> as a const reference; the property must be present and have the right type. More...

template<class T >
Property< T > &	updProperty (const PropertyIndex &index)
	Get property of known type Property<T> as a writable reference; the property must be present and have the right type. More...

bool	isObjectUpToDateWithProperties () const
	Returns `true` if no property's value has changed since the last time setObjectIsUpToDateWithProperties() was called. More...

void	readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
	We're given an XML element from which we are to populate this Object. More...

virtual void	updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
	Use this method to deserialize an object from a SimTK::Xml::Element. More...

void	updateXMLNode (SimTK::Xml::Element &parent, const AbstractProperty *prop=nullptr) const
	Serialize this object into the XML node that represents it. More...

bool	getInlined () const
	Inlined means an in-memory Object that is not associated with an XMLDocument. More...

void	setInlined (bool aInlined, const std::string &aFileName="")
	Mark this as inlined or not and optionally provide a file name to associate with the new XMLDocument for the non-inline case. More...

std::string	getDocumentFileName () const
	If there is a document associated with this object then return the file name maintained by the document. More...

int	getDocumentFileVersion () const
	If there is a document associated with this object then return its version number. More...

void	setAllPropertiesUseDefault (bool aUseDefault)

bool	print (const std::string &fileName) const
	Write this Object into an XML file of the given name; conventionally the suffix to use is ".osim". More...

std::string	dump () const
	dump the XML representation of this Object into an std::string and return it. More...

virtual bool	isA (const char *type) const
	The default implementation returns true only if the supplied string is "Object"; each Object-derived class overrides this to match its own class name. More...

const std::string &	toString () const
	Wrapper to be used on Java side to display objects in tree; this returns just the object's name. More...

PropertySet &	getPropertySet ()
	OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...

const PropertySet &	getPropertySet () const

Auto-generated functions
static MultivariatePolynomialFunction *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

static const std::string &	getClassName ()
	This returns "MultivariatePolynomialFunction". More...

MultivariatePolynomialFunction *	clone () const override
	Create a new heap-allocated copy of the concrete object to which this Object refers. More...

const std::string &	getConcreteClassName () const override
	Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string. More...

Additional Inherited Members
Static Public Member Functions inherited from OpenSim::Function
static Function *	makeFunctionOfType (Function *aFunction, const std::string &aNewTypeName)

static Function *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

static const std::string &	getClassName ()
	This returns "Function". More...

Static Public Member Functions inherited from OpenSim::Object
static void	registerType (const Object &defaultObject)
	Register an instance of a class; if the class is already registered it will be replaced. More...

static void	renameType (const std::string &oldTypeName, const std::string &newTypeName)
	Support versioning by associating the current Object type with an old name. More...

static const Object *	getDefaultInstanceOfType (const std::string &concreteClassName)
	Return a pointer to the default instance of the registered (concrete) Object whose class name is given, or NULL if the type is not registered. More...

template<class T >
static bool	isObjectTypeDerivedFrom (const std::string &concreteClassName)
	Return true if the given concrete object type represents a subclass of the template object type T, and thus could be referenced with a T*. More...

static Object *	newInstanceOfType (const std::string &concreteClassName)
	Create a new instance of the concrete Object type whose class name is given as concreteClassName. More...

static void	getRegisteredTypenames (Array< std::string > &typeNames)
	Retrieve all the typenames registered so far. More...

template<class T >
static void	getRegisteredObjectsOfGivenType (ArrayPtrs< T > &rArray)
	Return an array of pointers to the default instances of all registered (concrete) Object types that derive from a given Object-derived type that does not have to be concrete. More...

static bool	PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName, bool printFlagInfo=true)
	Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects. More...

static bool	PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName, bool printFlagInfo=true)
	Same as the other signature but the class name and property name are provided as two separate strings. More...

static Object *	makeObjectFromFile (const std::string &fileName)
	Create an OpenSim object whose type is based on the tag at the root node of the XML file passed in. More...

static const std::string &	getClassName ()
	Return the name of this class as a string; i.e., "Object". More...

static void	setSerializeAllDefaults (bool shouldSerializeDefaults)
	Static function to control whether all registered objects and their properties are written to the defaults section of output files rather than only those values for which the default was explicitly overwritten when read in from an input file or set programmatically. More...

static bool	getSerializeAllDefaults ()
	Report the value of the "serialize all defaults" flag. More...

static bool	isKindOf (const char *type)
	Returns true if the passed-in string is "Object"; each Object-derived class defines a method of this name for its own class name. More...

static void	setDebugLevel (int newLevel)
	Set the amount of logging output. More...

static int	getDebugLevel ()
	Get the current setting of debug level. More...

static Object *	SafeCopy (const Object *aObject)
	Use the clone() method to duplicate the given object unless the pointer is null in which case null is returned. More...

static void	RegisterType (const Object &defaultObject)
	OBSOLETE alternate name for registerType(). More...

static void	RenameType (const std::string &oldName, const std::string &newName)
	OBSOLETE alternate name for renameType(). More...

Detailed Description

A multivariate polynomial function.

This implementation assumes a maximum of four input dimensions and allows computation of first-order derivatives only.

Parameters

coefficients

the polynomial coefficients in order of ascending powers starting from the last dependent component. For a polynomial of third order dependent on three components (X, Y, Z), the order is a follows:

Index | X  Y  Z
0     | 0  0  0
1     | 0  0  1
2     | 0  0  2
3     | 0  0  3
4     | 0  1  0
5     | 0  1  1
6     | 0  1  2
7     | 0  2  0
8     | 0  2  1
9     | 0  3  0
10    | 1  0  0
11    | 1  0  1
12    | 1  0  2
13    | 1  1  0
14    | 1  1  1
15    | 1  2  0
16    | 2  0  0
17    | 2  0  1
18    | 2  1  0
19    | 3  0  0

Assuming c6 the index 6 coefficient, the corresponding term is Y Z^2.

Note: The order of coefficients for this class is the *opposite** from the order used in the univariate PolynomialFunction.

Parameters

dimension	the number of dependent components
order	the polynomial order (the largest sum of exponents in a single term)

Constructor & Destructor Documentation

◆ MultivariatePolynomialFunction() [1/2]

OpenSim::MultivariatePolynomialFunction::MultivariatePolynomialFunction ( )

inline

◆ MultivariatePolynomialFunction() [2/2]

OpenSim::MultivariatePolynomialFunction::MultivariatePolynomialFunction	(	SimTK::Vector	coefficients,
		int	dimension,
		int	order
	)

inline

Member Function Documentation

◆ clone()

MultivariatePolynomialFunction* OpenSim::MultivariatePolynomialFunction::clone ( ) const

inlineoverridevirtual

Create a new heap-allocated copy of the concrete object to which this Object refers.

It is up to the caller to delete the returned object when no longer needed. Every concrete object deriving from Object implements this pure virtual method automatically, via the declaration macro it invokes (e.g., OpenSim_DECLARE_CONCRETE_OBJECT()). Note that the concrete class overrides modify the return type to be a pointer to the concrete object; that still overrides the base class method because the return type is covariant with (that is, derives from) Object.

Implements OpenSim::Function.

◆ createSimTKFunction()

SimTK::Function* OpenSim::MultivariatePolynomialFunction::createSimTKFunction ( ) const

overridevirtual

Return function.

Implements OpenSim::Function.

◆ get_coefficients()

const SimTK::Vector& OpenSim::MultivariatePolynomialFunction::get_coefficients ( ) const

inline

Get the value of the coefficients property.

◆ get_dimension()

const int& OpenSim::MultivariatePolynomialFunction::get_dimension ( ) const

inline

Get the value of the dimension property.

◆ get_order()

const int& OpenSim::MultivariatePolynomialFunction::get_order ( ) const

inline

Get the value of the order property.

◆ getClassName()

static const std::string& OpenSim::MultivariatePolynomialFunction::getClassName ( )

inlinestatic

This returns "MultivariatePolynomialFunction".

See getConcreteClassName() if you want the class name of the underlying concrete object instead.

◆ getCoefficients()

const SimTK::Vector& OpenSim::MultivariatePolynomialFunction::getCoefficients ( ) const

inline

Get coefficients.

◆ getConcreteClassName()

const std::string& OpenSim::MultivariatePolynomialFunction::getConcreteClassName ( ) const

inlineoverridevirtual

Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string.

This is the string that is used as the tag for this concrete object in an XML file. Every concrete class derived from Object automatically overrides this method via the declaration macro it uses. See getClassName() to get the class name of the referencing (possibly abstract) class rather than the concrete object.

See also: getClassName()

Implements OpenSim::Function.

◆ getDimension()

int OpenSim::MultivariatePolynomialFunction::getDimension ( ) const

inline

Get dimension.

◆ getOrder()

int OpenSim::MultivariatePolynomialFunction::getOrder ( ) const

inline

Get order.

◆ safeDownCast()

static MultivariatePolynomialFunction* OpenSim::MultivariatePolynomialFunction::safeDownCast ( OpenSim::Object * obj )

inlinestatic

For use in MATLAB and Python to access the concrete class.

Example: cObj = MultivariatePolynomialFunction.safeDownCast(obj). This is equivalent to dynamic_cast<MultivariatePolynomialFunction*>(obj) in C++.

◆ set_coefficients()

void OpenSim::MultivariatePolynomialFunction::set_coefficients ( const SimTK::Vector & value )

inline

Set the value of the coefficients property.

◆ set_dimension()

void OpenSim::MultivariatePolynomialFunction::set_dimension ( const int & value )

inline

Set the value of the dimension property.

◆ set_order()

void OpenSim::MultivariatePolynomialFunction::set_order ( const int & value )

inline

Set the value of the order property.

◆ setCoefficients()

void OpenSim::MultivariatePolynomialFunction::setCoefficients ( SimTK::Vector coefficients )

inline

Set coefficients.

◆ setDimension()

void OpenSim::MultivariatePolynomialFunction::setDimension ( int dimension )

inline

Set dimension.

◆ setOrder()

void OpenSim::MultivariatePolynomialFunction::setOrder ( int order )

inline

Set order (largest sum of exponents in a single term).

◆ upd_coefficients()

SimTK::Vector& OpenSim::MultivariatePolynomialFunction::upd_coefficients ( )

inline

Get a writable reference to the coefficients property.

◆ upd_dimension()

int& OpenSim::MultivariatePolynomialFunction::upd_dimension ( )

inline

Get a writable reference to the dimension property.

◆ upd_order()

int& OpenSim::MultivariatePolynomialFunction::upd_order ( )

inline

Get a writable reference to the order property.

OpenSim Property, Socket, Output, Input Documentation

◆ coefficients

SimTK::Vector OpenSim::MultivariatePolynomialFunction::coefficients

"Coefficients of a multivariate polynomial function in order of" " ascending powers starting from the last dependent component."

This property appears in XML files under the tag <coefficients>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_coefficients(), upd_coefficients(), set_coefficients()

◆ dimension

int OpenSim::MultivariatePolynomialFunction::dimension

"Number of input dimensions (i.e., dependent components)."

This property appears in XML files under the tag <dimension>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_dimension(), upd_dimension(), set_dimension()

◆ order

int OpenSim::MultivariatePolynomialFunction::order

"The largest sum of exponents in a single term."

This property appears in XML files under the tag <order>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also: get_order(), upd_order(), set_order()

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

OpenSim/Common/MultivariatePolynomialFunction.h

OpenSim Properties, Sockets, Outputs, Inputs

Public Member Functions

Auto-generated functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MultivariatePolynomialFunction() [1/2]

◆ MultivariatePolynomialFunction() [2/2]

Member Function Documentation

◆ clone()

◆ createSimTKFunction()

◆ get_coefficients()

◆ get_dimension()

◆ get_order()

◆ getClassName()

◆ getCoefficients()

◆ getConcreteClassName()

◆ getDimension()

◆ getOrder()

◆ safeDownCast()

◆ set_coefficients()

◆ set_dimension()

◆ set_order()

◆ setCoefficients()

◆ setDimension()

◆ setOrder()

◆ upd_coefficients()

◆ upd_dimension()

◆ upd_order()

OpenSim Property, Socket, Output, Input Documentation

◆ coefficients

◆ dimension

◆ order