Class SwimmerInfoV5
- Namespace
- Gym.Environments.Envs.MuJoCo
- Assembly
- Gym.Environments.dll
Swimmer-v5's info (SwimmerEnvV5), typed (DR-91): a reset sends the first three keys, a step all seven.
public sealed record SwimmerInfoV5 : MujocoInfo, IEquatable<EnvInfo>, IEquatable<MujocoInfo>, IEquatable<SwimmerInfoV5>
- Inheritance
-
SwimmerInfoV5
- Implements
- Inherited Members
- Extension Methods
Constructors
SwimmerInfoV5(double, double, double, double?, double?, double?, double?)
Swimmer-v5's info (SwimmerEnvV5), typed (DR-91): a reset sends the first three keys, a step all seven.
public SwimmerInfoV5(double XPosition, double YPosition, double DistanceFromOrigin, double? XVelocity, double? YVelocity, double? RewardForward, double? RewardCtrl)
Parameters
XPositiondoubleThe front tip's x position (
x_position,qpos[0]).YPositiondoubleThe front tip's y position (
y_position,qpos[1]).DistanceFromOrigindoubleThe front tip's distance from the origin in the x-y plane (
distance_from_origin).XVelocitydouble?The x velocity over the step (
x_velocity); null on a reset's info.YVelocitydouble?The y velocity over the step (
y_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).
Properties
DistanceFromOrigin
The front tip's distance from the origin in the x-y plane (distance_from_origin).
public double DistanceFromOrigin { get; init; }
Property Value
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
XPosition
The front tip'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
YPosition
The front tip's y position (y_position, qpos[1]).
public double YPosition { get; init; }
Property Value
YVelocity
The y velocity over the step (y_velocity); null on a reset's info.
public double? YVelocity { get; init; }
Property Value
Methods
Equals(SwimmerInfoV5?)
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(SwimmerInfoV5? other)
Parameters
otherSwimmerInfoV5The 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(SwimmerInfoV5)
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(SwimmerInfoV5 value)
Parameters
valueSwimmerInfoV5The record.
Returns
- Info
A new dict; array values are shared, not copied.
Exceptions
- ArgumentNullException
Thrown when
valueis null.
implicit operator SwimmerInfoV5(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 SwimmerInfoV5(Info value)
Parameters
valueInfoThe info dict, typically
step.Info; the record shares it.
Returns
- SwimmerInfoV5
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.