Class sdm::Joint

template <class T>

Class List > sdm > Joint

This class is used for joint objects. It can be a JointHistoryTree , a JointObservation, a JointAction, etc.More...

• #include <joint.hpp>

Inherits the following classes: std::vector< T >, sdm::Function

Public Types

Type	Name
typedef T	value_type

Public Types inherited from sdm::Function

See sdm::Function

Type	Name
typedef TInput	input_type
typedef TOutput	output_type

Public Functions

Type	Name
	Joint ()
	Joint (const std::vector< T > & joint_item)
	Joint (const std::vector< number > &, const std::vector< T > & joint_item)
	Joint (std::initializer_list< T > list_values)
const T &	get (const number &) const Get the element for agent i.
number	getNumAgents () const Get the number of agents (i.e. the size of the joint element)
virtual T	operator() (const number &) Get the element for agent i.
void	serialize (Archive & archive, const unsigned int)
std::string	str () const
std::shared_ptr< Joint< std::shared_ptr< TOutput > > >	toJoint ()
virtual	~Joint ()

Public Functions inherited from sdm::Function

See sdm::Function

Type	Name
virtual output_type	operator() (const input_type &) = 0
virtual	~Function ()

Detailed Description

Template parameters:

• The type of item.

Public Types Documentation

typedef value_type

using sdm::Joint< T >::value_type =  T;

Public Functions Documentation

function Joint [1/4]

sdm::Joint::Joint () 

function Joint [2/4]

sdm::Joint::Joint (
    const std::vector< T > & joint_item
) 

function Joint [3/4]

sdm::Joint::Joint (
    const std::vector< number > &,
    const std::vector< T > & joint_item
) 

function Joint [4/4]

sdm::Joint::Joint (
    std::initializer_list< T > list_values
) 

function get

const T & sdm::Joint::get (
    const number &
) const

function getNumAgents

number sdm::Joint::getNumAgents () const

function operator()

virtual T sdm::Joint::operator() (
    const number &
) 

Implements sdm::Function::operator()

function serialize

template<class Archive class Archive>
inline void sdm::Joint::serialize (
    Archive & archive,
    const unsigned int
) 

function str

std::string sdm::Joint::str () const

function toJoint

template<typename TOutput typename TOutput>
std::shared_ptr< Joint < std::shared_ptr< TOutput > > > sdm::Joint::toJoint () 

function ~Joint

virtual sdm::Joint::~Joint () 

Friends Documentation

friend access

friend class sdm::Joint::access () 

friend operator<<

inline friend std::ostream & sdm::Joint::operator<< (
    std::ostream & os,
    const Joint < T > & joint_item
) 

Parameters:

• std::ostream&
• const joint<item, instance>& joint item to be printed

Returns:

std::ostream&

---

The documentation for this class was generated from the following file src/sdm/core/joint.hpp