Struct IndexSpace

pub struct IndexSpace {
    pub size: usize,
}

An index space; consists of the integers 0 to size - 1

Fields

size: usize

Implementations

impl IndexSpace

pub const fn new(size: usize) -> Self

Trait Implementations

impl Clone for IndexSpace

fn clone(&self) -> IndexSpace

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IndexSpace

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexSpace

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IndexSpace

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Distribution<<IndexSpace as Space>::Element> for IndexSpace

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> <Self as Space>::Element

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl FeatureSpace for IndexSpace

Features are one-hot vectors

fn num_features(&self) -> usize

Length of the encoded feature vectors.

fn features_out<'a, F: Float>( &self, element: &Self::Element, out: &'a mut [F], zeroed: bool, ) -> &'a mut [F]

Encode the feature vector of an element into a mutable slice.

fn batch_features_out<'a, I, A>( &self, elements: I, out: &mut ArrayBase<A, Ix2>, zeroed: bool, )

where I: IntoIterator<Item = &'a Self::Element>, Self::Element: 'a, A: DataMut, A::Elem: Float,

Encode the feature vectors of multiple elements into rows of a two-dimensional array.

fn features<T>(&self, element: &Self::Element) -> T

where T: BuildFromArray1D, <T::Array as NumArray1D>::Elem: Float,

Encode the feature vector of an element into an array.

fn batch_features<'a, I, T>(&self, elements: I) -> T

where I: IntoIterator<Item = &'a Self::Element>, I::IntoIter: ExactSizeIterator, Self::Element: 'a, T: BuildFromArray2D, <T::Array as NumArray2D>::Elem: Float,

Encode the feature vectors of multiple elements as rows of a two-dimensional array.

impl FiniteSpace for IndexSpace

fn size(&self) -> usize

The number of elements in the space.

fn to_index(&self, element: &Self::Element) -> usize

Get the (unique) index of an element.

fn from_index(&self, index: usize) -> Option<Self::Element>

Try to convert an index to an element.

fn from_index_unchecked(&self, index: usize) -> Option<Self::Element>

Try to convert an index to an element.

impl<T: FiniteSpace + ?Sized> From<&T> for IndexSpace

fn from(space: &T) -> Self

Converts to this type from the input type.

impl Hash for IndexSpace

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LogElementSpace for IndexSpace

Log the index as a sample from 0..N

fn log_element<L: StatsLogger + ?Sized>( &self, name: &'static str, element: &Self::Element, logger: &mut L, ) -> Result<(), LogError>

Log an element of the space

impl NonEmptySpace for IndexSpace

fn some_element(&self) -> <Self as Space>::Element

An arbitrary deterministic element from the space.

impl ParameterizedDistributionSpace<Tensor> for IndexSpace

type Distribution = Categorical

Batched distribution type.

fn num_distribution_params(&self) -> usize

Size of the parameter vector for which elements are sampled.

fn sample_element(&self, params: &Tensor) -> Self::Element

Sample a single element given a parameter vector.

fn distribution(&self, params: &Tensor) -> Self::Distribution

The distribution parameterized by the given parameter vector.

impl PartialEq for IndexSpace

fn eq(&self, other: &IndexSpace) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ReprSpace<Tensor> for IndexSpace

Represents elements as integer tensors.

fn repr(&self, element: &Self::Element) -> Tensor

Representation of a single element.

fn batch_repr<'a, I>(&self, elements: I) -> Tensor

where I: IntoIterator<Item = &'a Self::Element>, Self::Element: 'a,

Represent a batch of elements as an array.

impl Serialize for IndexSpace

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Space for IndexSpace

type Element = usize

fn contains(&self, value: &Self::Element) -> bool

Check whether a particular value is contained in the space.

impl SubsetOrd for IndexSpace

fn subset_cmp(&self, other: &Self) -> Option<Ordering>

Compare using the subset relationship. This is a partial order.

fn strict_subset_of(&self, other: &Self) -> bool

Check if this is a strict subset of other.

fn subset_of(&self, other: &Self) -> bool

Check if this is a subset (strict or equal) of other.

fn strict_superset_of(&self, other: &Self) -> bool

Check if this is a strict superset of other.

fn superset_of(&self, other: &Self) -> bool

Check if this is a superset (strict or equal) of other.

impl Copy for IndexSpace

impl Eq for IndexSpace

impl StructuralPartialEq for IndexSpace