MultiAgentDecisionProcess  Release 0.2.1
Policy Class Reference

Policy is a class that represents a policy for a single agent. More...

#include <Policy.h>

+ Inheritance diagram for Policy:

Public Member Functions

virtual PolicyClone () const =0
 Returns a pointer to a copy of this class.
size_t GetDepth () const
 Returns the depth of the policy.
 Policy (Index agentI)
 Constructor, initializes the depth to the maximum horizon.
virtual void Print () const
 Prints a description of a policy to cout.
virtual void SetDepth (size_t d)
 Sets the depth of the policy.
virtual std::string SoftPrint () const =0
 Prints a description of a policy to a string.
virtual ~Policy ()
 Destructor.

Protected Attributes

Index _m_agentI

Private Attributes

size_t _m_depth
 The depth of this joint policy.

Detailed Description

Policy is a class that represents a policy for a single agent.

It contains the notion of the depth of a policy: a positive number that specifies for how many time steps this policy is specified. I.e., if depth < horizon, the object represents a partially specified policy (specified for time steps 0,...,depth-1)

Definition at line 43 of file Policy.h.

Constructor & Destructor Documentation

Policy::Policy ( Index  agentI)
inline

Constructor, initializes the depth to the maximum horizon.

Definition at line 65 of file Policy.h.

virtual Policy::~Policy ( )
inlinevirtual

Destructor.

Definition at line 71 of file Policy.h.

Member Function Documentation

virtual Policy* Policy::Clone ( ) const
pure virtual

Returns a pointer to a copy of this class.

Implemented in PolicyPureVector, PolicyDiscrete, and PolicyDiscretePure.

size_t Policy::GetDepth ( ) const
inline

Returns the depth of the policy.

See Also
_m_depth

Definition at line 74 of file Policy.h.

References _m_depth.

Referenced by PolicyPureVector::GetIndex(), PolicyPureVector::Increment(), and PolicyPureVector::SetIndex().

virtual void Policy::Print ( ) const
inlinevirtual

Prints a description of a policy to cout.

Definition at line 84 of file Policy.h.

References SoftPrint().

virtual void Policy::SetDepth ( size_t  d)
inlinevirtual

Sets the depth of the policy.

See Also
_m_depth

Reimplemented in PolicyPureVector.

Definition at line 76 of file Policy.h.

References _m_depth.

virtual std::string Policy::SoftPrint ( ) const
pure virtual

Prints a description of a policy to a string.

Implemented in PolicyPureVector.

Referenced by Print().

Member Data Documentation

Index Policy::_m_agentI
protected

Definition at line 59 of file Policy.h.

Referenced by PolicyDiscrete::SampleAction().

size_t Policy::_m_depth
private

The depth of this joint policy.

The depth of the policy is the number of stages for which it specifies actions. It ranges from:
0 (the empty policy),
1 (a policy specified only for ts=0),
: MAXHORIZON (a policy specified for all stages, the default value).

Definition at line 56 of file Policy.h.

Referenced by GetDepth(), and SetDepth().


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