The State class defines an abstract base class for the state information and gym data. More...

Public Member Functions
	State ()
	The constructor. More...

abstract State	Clone ()
	Copies the state to another new state. More...

abstract SimpleDatum	GetData (bool bNormalize, out int nDataLen)
	Get the data. More...

virtual SimpleDatum	GetClip ()
	Get the clip data (used with recurrent models such as LSTM). More...

virtual SimpleDatum	GetLabel ()
	Get the label data (used with recurrent models such as LSTM with dynamic data). More...

Protected Attributes
List< DataPoint >	m_rgPrevPoints = new List<DataPoint>()
	Contains the history of the previous target points. More...

Properties
virtual bool	HasClip `[get]`
	Returns 'true' if this State supports clip data. More...

virtual bool	HasLabel `[get]`
	Returns 'true' if this state supports label data. More...

List< DataPoint >	History `[get]`
	Returns the history of the previous points if provided by the gym. More...

Detailed Description

The State class defines an abstract base class for the state information and gym data.

Definition at line 336 of file Interfaces.cs.

Constructor & Destructor Documentation

◆ State()

MyCaffe.gym.State.State ( )

The constructor.

Definition at line 346 of file Interfaces.cs.

Member Function Documentation

◆ Clone()

abstract State MyCaffe.gym.State.Clone ( )

pure virtual

Copies the state to another new state.

Returns: The new state information and gym data is returned.

◆ GetClip()

virtual SimpleDatum MyCaffe.gym.State.GetClip ( )

virtual

Get the clip data (used with recurrent models such as LSTM).

Returns: The clip data corresponding to the GetData is returned.

Definition at line 369 of file Interfaces.cs.

◆ GetData()

abstract SimpleDatum MyCaffe.gym.State.GetData	(	bool	bNormalize,
		out int	nDataLen
	)

pure virtual

Get the data.

Parameters

bNormalize	Specifies to normalize the data.
nDataLen	Returns the non-render data length (the actual data used in training)

Returns: A tuple with the SimpleDatum containing the data and the non rendering data length is returned.

◆ GetLabel()

virtual SimpleDatum MyCaffe.gym.State.GetLabel ( )

virtual

Get the label data (used with recurrent models such as LSTM with dynamic data).

Returns: The label data is returned.

Definition at line 378 of file Interfaces.cs.

Member Data Documentation

◆ m_rgPrevPoints

List<DataPoint> MyCaffe.gym.State.m_rgPrevPoints = new List<DataPoint>()

protected

Contains the history of the previous target points.

Definition at line 341 of file Interfaces.cs.

Property Documentation

◆ HasClip

virtual bool MyCaffe.gym.State.HasClip

get

Returns 'true' if this State supports clip data.

Definition at line 364 of file Interfaces.cs.

◆ HasLabel

virtual bool MyCaffe.gym.State.HasLabel

get

Returns 'true' if this state supports label data.

Definition at line 373 of file Interfaces.cs.

◆ History

List<DataPoint> MyCaffe.gym.State.History

get

Returns the history of the previous points if provided by the gym.

Definition at line 383 of file Interfaces.cs.

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

C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.gym/Interfaces.cs

Public Member Functions

Protected Attributes

Properties