bitrl::VectorTimeStep< StateType > Class Template Reference

Forward declaration. More...

#include <vector_time_step.h>

Public Types
typedef StateType	state_type
	state_ Type of the state

Public Member Functions
	VectorTimeStep ()=default
	Default construcotr.
	VectorTimeStep (const std::vector< TimeStepTp > &types, const std::vector< real_t > &rewards, const std::vector< state_type > &obs)
	VectorTimeStep. Constructor.
	VectorTimeStep (const std::vector< TimeStepTp > &types, const std::vector< real_t > &rewards, const std::vector< state_type > &obs, const std::vector< real_t > &discount_factors)
	VectorTimeStep. Constructor.
	VectorTimeStep (const std::vector< TimeStepTp > &types, const std::vector< real_t > &rewards, const std::vector< state_type > &obs, const std::vector< real_t > &discount_factors, std::unordered_map< std::string, std::any > &&extra)
	VectorTimeStep (const VectorTimeStep &other)
	TimeStep.
VectorTimeStep &	operator= (const VectorTimeStep &other)
	Assignment operator.
	VectorTimeStep (VectorTimeStep &&other) noexcept
	TimeStep.
VectorTimeStep &	operator= (VectorTimeStep &&other) noexcept
	operator =
const std::vector< TimeStepTp > &	types () const noexcept
	type
const std::vector< state_type > &	observations () const
	observation
const std::vector< real_t > &	rewards () const noexcept
	reward
real_t	reward () const noexcept
	Returns the sum of the rewards received.
bool	done () const noexcept
	Returns true if any time step is LAST.
const std::vector< real_t > &	discounts () const noexcept
	discount. Returns the discount factor
bool	last () const noexcept
	last

Detailed Description

template<typename StateType>
class bitrl::VectorTimeStep< StateType >

Forward declaration.

VectorTimeSetp class.

Member Typedef Documentation

state_type

template<typename StateType >

typedef StateType bitrl::VectorTimeStep< StateType >::state_type

state_ Type of the state

Constructor & Destructor Documentation

VectorTimeStep() [1/6]

template<typename StateType >

bitrl::VectorTimeStep< StateType >::VectorTimeStep ( )

default

Default construcotr.

VectorTimeStep() [2/6]

template<typename StateType >

bitrl::VectorTimeStep< StateType >::VectorTimeStep	(	const std::vector< TimeStepTp > &	types,
		const std::vector< real_t > &	rewards,
		const std::vector< state_type > &	obs
	)

VectorTimeStep. Constructor.

VectorTimeStep() [3/6]

template<typename StateType >

bitrl::VectorTimeStep< StateType >::VectorTimeStep	(	const std::vector< TimeStepTp > &	types,
		const std::vector< real_t > &	rewards,
		const std::vector< state_type > &	obs,
		const std::vector< real_t > &	discount_factors
	)

VectorTimeStep. Constructor.

VectorTimeStep() [4/6]

template<typename StateType >

bitrl::VectorTimeStep< StateType >::VectorTimeStep	(	const std::vector< TimeStepTp > &	types,
		const std::vector< real_t > &	rewards,
		const std::vector< state_type > &	obs,
		const std::vector< real_t > &	discount_factors,
		std::unordered_map< std::string, std::any > &&	extra
	)

VectorTimeStep() [5/6]

template<typename StateType >

bitrl::VectorTimeStep< StateType >::VectorTimeStep

(

const VectorTimeStep< StateType > &

other

)

TimeStep.

Parameters

other

VectorTimeStep() [6/6]

template<typename StateType >

bitrl::VectorTimeStep< StateType >::VectorTimeStep ( VectorTimeStep< StateType > &&  other )

noexcept

TimeStep.

Parameters

other

Member Function Documentation

discounts()

template<typename StateType >

const std::vector< real_t > & bitrl::VectorTimeStep< StateType >::discounts ( ) const

inlinenoexcept

discount. Returns the discount factor

done()

template<typename StateType >

bool bitrl::VectorTimeStep< StateType >::done ( ) const

noexcept

Returns true if any time step is LAST.

last()

template<typename StateType >

bool bitrl::VectorTimeStep< StateType >::last ( ) const

noexcept

last

Returns

observations()

template<typename StateType >

const std::vector< state_type > & bitrl::VectorTimeStep< StateType >::observations ( ) const

inline

observation

Returns

operator=() [1/2]

template<typename StateType >

VectorTimeStep< StateType > & bitrl::VectorTimeStep< StateType >::operator=

(

const VectorTimeStep< StateType > &

other

)

Assignment operator.

operator=() [2/2]

template<typename StateType >

VectorTimeStep< StateType > & bitrl::VectorTimeStep< StateType >::operator= ( VectorTimeStep< StateType > &&  other )

noexcept

operator =

Parameters

other

Returns

reward()

template<typename StateType >

real_t bitrl::VectorTimeStep< StateType >::reward ( ) const

noexcept

Returns the sum of the rewards received.

rewards()

template<typename StateType >

const std::vector< real_t > & bitrl::VectorTimeStep< StateType >::rewards ( ) const

inlinenoexcept

reward

Returns

types()

template<typename StateType >

const std::vector< TimeStepTp > & bitrl::VectorTimeStep< StateType >::types ( ) const

inlinenoexcept

type

Returns

---

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

• libs/bitrl/src/bitrl/envs/gymnasium/classic_control/vector/acrobot_vec_env.h
• libs/bitrl/src/bitrl/envs/vector_time_step.h