Public Member Functions | List of all members
ignition::math::ControlPoint Class Reference

Control point representation for polynomial interpolation, defined in terms of arbitrary m derivatives at such point. More...

#include <SplinePrivate.hh>

Public Member Functions

 ControlPoint (const std::vector< Vector3d > &_initList)
 Constructor that takes the M derivatives that define the control point. More...
 
void Match (const ControlPoint &_other)
 Matches all mth derivatives defined in _other to this. More...
 
Vector3d MthDerivative (const unsigned int _mth) const
 Gets the mth derivative of this control point. More...
 
Vector3dMthDerivative (const unsigned int _mth)
 Returns a mutable reference to the mth derivative of this control point. More...
 
bool operator== (const ControlPoint &_other) const
 Checks for control point equality. More...
 

Detailed Description

Control point representation for polynomial interpolation, defined in terms of arbitrary m derivatives at such point.

Constructor & Destructor Documentation

§ ControlPoint()

ignition::math::ControlPoint::ControlPoint ( const std::vector< Vector3d > &  _initList)
inlineexplicit

Constructor that takes the M derivatives that define the control point.

Parameters
[in]_initListwith the M derivatives.

Member Function Documentation

§ Match()

void ignition::math::ControlPoint::Match ( const ControlPoint _other)
inline

Matches all mth derivatives defined in _other to this.

Remarks
Higher order derivatives in this and not defined in _other are kept.
Parameters
[in]_othercontrol point to be matches.

§ MthDerivative() [1/2]

Vector3d ignition::math::ControlPoint::MthDerivative ( const unsigned int  _mth) const
inline

Gets the mth derivative of this control point.

Remarks
Higher derivatives than those defined default to [0.0, 0.0, 0.0].
Parameters
[in]_mthderivative order.
Returns
The mth derivative value.

§ MthDerivative() [2/2]

Vector3d& ignition::math::ControlPoint::MthDerivative ( const unsigned int  _mth)
inline

Returns a mutable reference to the mth derivative of this control point.

Remarks
Higher derivatives than those defined default to [0.0, 0.0, 0.0].
Parameters
[in]_mthderivative order.
Returns
The mth derivative value.

§ operator==()

bool ignition::math::ControlPoint::operator== ( const ControlPoint _other) const
inline

Checks for control point equality.

Parameters
[in]_othercontrol point to compare against.
Returns
whether this and _other can be seen as equal.

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