Table of Contents

Class PusherInfoV5

Namespace
Gym.Environments.Envs.MuJoCo
Assembly
Gym.Environments.dll

Pusher-v5's info (PusherEnvV5), typed (DR-91): a step's three keys; a reset sends {}.

public sealed record PusherInfoV5 : MujocoInfo, IEquatable<EnvInfo>, IEquatable<MujocoInfo>, IEquatable<PusherInfoV5>
Inheritance
PusherInfoV5
Implements
Inherited Members
Extension Methods

Constructors

PusherInfoV5(double?, double?, double?)

Pusher-v5's info (PusherEnvV5), typed (DR-91): a step's three keys; a reset sends {}.

public PusherInfoV5(double? RewardDist, double? RewardCtrl, double? RewardNear)

Parameters

RewardDist double?

The distance term, the negative weighted distance of the object from the goal (reward_dist).

RewardCtrl double?

The control term, the negative weighted squared action, sent in the action's dtype (reward_ctrl).

RewardNear double?

The near term, the negative weighted distance of the fingertip from the object (reward_near).

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

double?

RewardDist

The distance term, the negative weighted distance of the object from the goal (reward_dist).

public double? RewardDist { get; init; }

Property Value

double?

RewardNear

The near term, the negative weighted distance of the fingertip from the object (reward_near).

public double? RewardNear { get; init; }

Property Value

double?

Methods

Equals(PusherInfoV5?)

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(PusherInfoV5? other)

Parameters

other PusherInfoV5

The other record.

Returns

bool

true when the members are equal.

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(PusherInfoV5)

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(PusherInfoV5 value)

Parameters

value PusherInfoV5

The record.

Returns

Info

A new dict; array values are shared, not copied.

Exceptions

ArgumentNullException

Thrown when value is null.

implicit operator PusherInfoV5(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 PusherInfoV5(Info value)

Parameters

value Info

The info dict, typically step.Info; the record shares it.

Returns

PusherInfoV5

The record.

Exceptions

ArgumentNullException

Thrown when value is 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.