Class HopperInfoV5
- Namespace
- Gym.Environments.Envs.MuJoCo
- Assembly
- Gym.Environments.dll
Hopper-v5's info (HopperEnvV5), typed (DR-91): a reset sends the first two keys, a step all six.
public sealed record HopperInfoV5 : MujocoInfo, IEquatable<EnvInfo>, IEquatable<MujocoInfo>, IEquatable<HopperInfoV5>
- Inheritance
-
HopperInfoV5
- Implements
- Inherited Members
- Extension Methods
Constructors
HopperInfoV5(double, double, double?, double?, double?, double?)
Hopper-v5's info (HopperEnvV5), typed (DR-91): a reset sends the first two keys, a step all six.
public HopperInfoV5(double XPosition, double ZDistanceFromOrigin, double? XVelocity, double? RewardForward, double? RewardCtrl, double? RewardSurvive)
Parameters
XPositiondoubleThe torso's x position (
x_position,qpos[0]).ZDistanceFromOrigindoubleThe torso's height above its initial height (
z_distance_from_origin).XVelocitydouble?The x velocity over the step (
x_velocity); null on a reset's info.RewardForwarddouble?The forward term of the reward, the weighted x velocity (
reward_forward).RewardCtrldouble?The control term, the negative weighted squared action, sent in the action's dtype (
reward_ctrl).RewardSurvivedouble?The healthy term (
reward_survive): the healthy reward while healthy, 0 otherwise.
Properties
RewardCtrl
The control term, the negative weighted squared action, sent in the action's dtype (reward_ctrl).
public double? RewardCtrl { get; init; }
Property Value
RewardForward
The forward term of the reward, the weighted x velocity (reward_forward).
public double? RewardForward { get; init; }
Property Value
RewardSurvive
The healthy term (reward_survive): the healthy reward while healthy, 0 otherwise.
public double? RewardSurvive { get; init; }
Property Value
XPosition
The torso's x position (x_position, qpos[0]).
public double XPosition { get; init; }
Property Value
XVelocity
The x velocity over the step (x_velocity); null on a reset's info.
public double? XVelocity { get; init; }
Property Value
ZDistanceFromOrigin
The torso's height above its initial height (z_distance_from_origin).
public double ZDistanceFromOrigin { get; init; }
Property Value
Methods
Equals(HopperInfoV5?)
Record equality (DR-92): the members compare as Python's == compares them (PyEquality), arrays by value; the dict inside takes no part.
public bool Equals(HopperInfoV5? other)
Parameters
otherHopperInfoV5The other record.
Returns
GetHashCode()
A hash consistent with Equals(object): the member count, as array members have no value hash.
public override int GetHashCode()
Returns
- int
The hash.
ToInfoCore()
The members as a new dict by Python name, in declaration order, a null member's key left out.
protected override Info ToInfoCore()
Returns
- Info
A new dict.
ToString()
Python's repr of the info dict (ToInfo()): {'x_position': np.float64(0.1), ...}.
public override string ToString()
Returns
- string
The text.
Operators
implicit operator Info(HopperInfoV5)
The record as an info dict (EnvInfo.ToInfo): the dict it was read from, the env's values kept, else its members by Python name.
public static implicit operator Info(HopperInfoV5 value)
Parameters
valueHopperInfoV5The record.
Returns
- Info
A new dict; array values are shared, not copied.
Exceptions
- ArgumentNullException
Thrown when
valueis null.
implicit operator HopperInfoV5(Info)
The typed record of an env's info dict (DR-91): each member read with InfoExtensions.Get<T>'s conversions,
a nullable member null when its key is absent; the record keeps the dict, whose values its indexer reads.
public static implicit operator HopperInfoV5(Info value)
Parameters
valueInfoThe info dict, typically
step.Info; the record shares it.
Returns
- HopperInfoV5
The record.
Exceptions
- ArgumentNullException
Thrown when
valueis null.- KeyError
Thrown, with Python's message, when the key of a member that is not nullable is missing.
- InvalidCastException
Thrown when a value cannot be read as its member's type.
- OverflowException
Thrown when an integer does not fit its member's type.