Struct OptionSpace

pub struct OptionSpace<S> {
    pub inner: S,
}

A space whose elements are either None or Some(inner_elem).

The feature vectors are

• [1, 0, ..., 0] for None
• [0, inner_feature_vector(x)] for Some(x).

Fields

inner: S

Implementations

impl<S> OptionSpace<S>

pub const fn new(inner: S) -> Self

Trait Implementations

impl<S: Clone> Clone for OptionSpace<S>

fn clone(&self) -> OptionSpace<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for OptionSpace<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for OptionSpace<S>

fn default() -> OptionSpace<S>

Returns the “default value” for a type.

impl<'de, S> Deserialize<'de> for OptionSpace<S>

where S: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: Display> Display for OptionSpace<S>

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

Formats the value using the given formatter.

impl<S> Distribution<<OptionSpace<S> as Space>::Element> for OptionSpace<S>

where S: Space + Distribution<S::Element>,

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<S: FeatureSpace> FeatureSpace for OptionSpace<S>

Features are [0.0, features(x)..] for Some(x) and [1.0, 0.0, ..., 0.0] for None.

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 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_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 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<S: FiniteSpace> FiniteSpace for OptionSpace<S>

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<S: Hash> Hash for OptionSpace<S>

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<S: LogElementSpace> LogElementSpace for OptionSpace<S>

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<S: Space> NonEmptySpace for OptionSpace<S>

fn some_element(&self) -> Self::Element

An arbitrary deterministic element from the space.

impl<S: Ord> Ord for OptionSpace<S>

fn cmp(&self, other: &OptionSpace<S>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<S: PartialEq> PartialEq for OptionSpace<S>

fn eq(&self, other: &OptionSpace<S>) -> 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<S: PartialOrd> PartialOrd for OptionSpace<S>

fn partial_cmp(&self, other: &OptionSpace<S>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<S> Serialize for OptionSpace<S>

where S: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S: Space> Space for OptionSpace<S>

type Element = Option<<S as Space>::Element>

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

Check whether a particular value is contained in the space.

impl<S: SubsetOrd> SubsetOrd for OptionSpace<S>

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<S: Copy> Copy for OptionSpace<S>

impl<S: Eq> Eq for OptionSpace<S>

impl<S> StructuralPartialEq for OptionSpace<S>