Skip to main content

SparseFeatures

Struct SparseFeatures 

Source
pub struct SparseFeatures { /* private fields */ }
Expand description

Sparse feature vector: sorted (FeatureId, value) pairs.

§Requirements

  • Sorted by FeatureId in ascending order.
  • No duplicate FeatureIds.
  • Zero values may be omitted.
  • Not a HashMap<String, f64>.

§Examples

use rill_ml::sparse::SparseFeatures;

let features = SparseFeatures::from_sorted(vec![
    (1, 0.5),
    (3, 2.0),
    (7, -1.0),
]).unwrap();
assert_eq!(features.len(), 3);
assert_eq!(features.get(3), Some(2.0));

Implementations§

Source§

impl SparseFeatures

Source

pub fn new() -> Self

Create an empty sparse feature vector.

Source

pub fn from_sorted(values: Vec<(FeatureId, f64)>) -> Result<Self, RillError>

Build from a Vec that is already sorted by FeatureId and contains no duplicates.

Returns an error if the input is unsorted, has duplicates, or contains non-finite values.

Source

pub fn from_unsorted(values: Vec<(FeatureId, f64)>) -> Result<Self, RillError>

Build from an unsorted Vec, sorting and merging duplicates by summing their values.

Non-finite values are rejected after merging.

Source

pub fn push(&mut self, id: FeatureId, value: f64) -> Result<(), RillError>

Append a single feature. The id must be strictly greater than the last inserted id.

Source

pub fn values(&self) -> &[(FeatureId, f64)]

Access the internal (FeatureId, value) slice.

Source

pub fn len(&self) -> usize

Number of non-zero (explicitly stored) features.

Source

pub fn is_empty(&self) -> bool

Whether no features are stored.

Source

pub fn get(&self, id: FeatureId) -> Option<f64>

Look up the value for a given FeatureId via binary search.

Source

pub fn iter(&self) -> impl Iterator<Item = (FeatureId, f64)> + '_

Iterate over (FeatureId, &value) pairs.

Source

pub fn validate(&self) -> Result<(), RillError>

Validate sorting, uniqueness, and finiteness.

Trait Implementations§

Source§

impl Clone for SparseFeatures

Source§

fn clone(&self) -> SparseFeatures

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SparseFeatures

Source§

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

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

impl Default for SparseFeatures

Source§

fn default() -> SparseFeatures

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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