Skip to main content

FixedSamples

sklears::types::const_generic

Struct FixedSamples 

Source 
pub struct FixedSamples<T, const M: usize, const N: usize>
where
    T: Numeric,
{ /* private fields */ }
Expand description

Fixed-size dataset with compile-time shape checking

Implementations§

Source§

impl<T, const M: usize, const N: usize> FixedSamples<T, M, N>
where T: Numeric,

Source

pub fn new(data: [[T; N]; M]) -> FixedSamples<T, M, N>

Create from nested array

Source

pub fn from_flat_slice( slice: &[T], ) -> Result<FixedSamples<T, M, N>, SklearsError>

Create from flat slice, checking length at runtime

Source

pub const fn sample_count() -> usize

Get sample count at compile time

Source

pub const fn feature_count() -> usize

Get feature count at compile time

Source

pub const fn shape() -> (usize, usize)

Get shape at compile time

Source

pub fn sample(&self, index: usize) -> FixedFeatures<T, N>
where T: FloatBounds,

Get a sample as FixedFeatures

Source

pub fn to_array2(&self) -> ArrayBase<OwnedRepr<T>, Dim<[usize; 2]>>

Convert to dynamic Array2

Source

pub fn from_array2( array: &ArrayBase<OwnedRepr<T>, Dim<[usize; 2]>>, ) -> Result<FixedSamples<T, M, N>, SklearsError>

Create from Array2, checking shape at runtime

Trait Implementations§

Source§

impl<T, const M: usize, const N: usize> Clone for FixedSamples<T, M, N>
where T: Clone + Numeric,

Source§

fn clone(&self) -> FixedSamples<T, M, N>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T, const M: usize, const N: usize> Debug for FixedSamples<T, M, N>
where T: Debug + Numeric,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T, const M: usize, const N: usize> Index<usize> for FixedSamples<T, M, N>
where T: Numeric,

Source§

type Output = [T; N]

The returned type after indexing.
Source§

fn index( &self, index: usize, ) -> &<FixedSamples<T, M, N> as Index<usize>>::Output

Performs the indexing (container[index]) operation. Read more
Source§

impl<T, const M: usize, const N: usize> IndexMut<usize> for FixedSamples<T, M, N>
where T: Numeric,

Source§

fn index_mut( &mut self, index: usize, ) -> &mut <FixedSamples<T, M, N> as Index<usize>>::Output

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl<T, const M: usize, const N: usize> MinFeatures<1> for FixedSamples<T, M, N>
where T: Numeric,

Source§

const FEATURE_COUNT: usize = N

Source§

const SATISFIES_MIN_FEATURES: bool = _

Source§

impl<T, const M: usize, const N: usize> MinSamples<1> for FixedSamples<T, M, N>
where T: Numeric,

Source§

const SAMPLE_COUNT: usize = M

Source§

const SATISFIES_MIN_SAMPLES: bool = _

Source§

impl<T, const M: usize, const N: usize> PartialEq for FixedSamples<T, M, N>
where T: PartialEq + Numeric,

Source§

fn eq(&self, other: &FixedSamples<T, M, N>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<T, const M: usize, const N: usize> ValidDimensions for FixedSamples<T, M, N>
where T: Numeric,

Source§

const IS_VALID: bool

Source§

impl<T, const M: usize, const N: usize> StructuralPartialEq for FixedSamples<T, M, N>
where T: Numeric,

Auto Trait Implementations§

§

impl<T, const M: usize, const N: usize> Freeze for FixedSamples<T, M, N>
where T: Freeze,

§

impl<T, const M: usize, const N: usize> RefUnwindSafe for FixedSamples<T, M, N>
where T: RefUnwindSafe,

§

impl<T, const M: usize, const N: usize> Send for FixedSamples<T, M, N>

§

impl<T, const M: usize, const N: usize> Sync for FixedSamples<T, M, N>

§

impl<T, const M: usize, const N: usize> Unpin for FixedSamples<T, M, N>
where T: Unpin,

§

impl<T, const M: usize, const N: usize> UnsafeUnpin for FixedSamples<T, M, N>
where T: UnsafeUnpin,

§

impl<T, const M: usize, const N: usize> UnwindSafe for FixedSamples<T, M, N>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,