Table of Contents

Class CliffWalkingInfo

Namespace
Gym.Environments.Envs.ToyText
Assembly
Gym.Environments.dll

CliffWalking's info (CliffWalkingEnv, CliffWalking-v1 and CliffWalkingSlippery-v1), typed (DR-91): {"prob": ...}.

public sealed record CliffWalkingInfo : ToyTextInfo, IEquatable<EnvInfo>, IEquatable<ToyTextInfo>, IEquatable<CliffWalkingInfo>
Inheritance
CliffWalkingInfo
Implements
Inherited Members
Extension Methods

Constructors

CliffWalkingInfo(double)

CliffWalking's info (CliffWalkingEnv, CliffWalking-v1 and CliffWalkingSlippery-v1), typed (DR-91): {"prob": ...}.

public CliffWalkingInfo(double Prob)

Parameters

Prob double

The probability of the transition just taken (prob); 1 at a reset.

Methods

Equals(CliffWalkingInfo?)

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

Parameters

other CliffWalkingInfo

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

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

Parameters

value CliffWalkingInfo

The record.

Returns

Info

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

Exceptions

ArgumentNullException

Thrown when value is null.

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

Parameters

value Info

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

Returns

CliffWalkingInfo

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.