ann_dataset

Struct PointSet

Source 
pub struct PointSet<DataType: Clone> { /* private fields */ }
Expand description

A set of points (dense, sparse, or both) represented as a matrix, where each row corresponds to a single vector.

Implementations§

Source§

impl<DataType: Clone> PointSet<DataType>

Source

pub fn new( dense: Option<Array2<DataType>>, sparse: Option<CsMat<DataType>>, ) -> Result<PointSet<DataType>>

Creates a point set.

Returns an error if both dense and sparse vector sets are empty, or if they are both provided, the number of rows of the dense and sparse sets do not match.

Source

pub fn num_points(&self) -> usize

Returns the number of points in the point set.

Source

pub fn num_dense_dimensions(&self) -> usize

Returns the number of dense dimensions.

Source

pub fn num_sparse_dimensions(&self) -> usize

Returns the number of sparse dimensions.

Source

pub fn num_dimensions(&self) -> usize

Returns the total number of dimensions.

Source

pub fn get_dense(&self) -> Option<&Array2<DataType>>

Returns the dense sub-vectors.

Source

pub fn get_sparse(&self) -> Option<&CsMat<DataType>>

Returns the sparse sub-vectors.

Source

pub fn select(&self, ids: &[usize]) -> PointSet<DataType>

Selects a subset of points with the given ids.

Source§

impl PointSet<f32>

Source

pub fn l2_norm(&self) -> Array1<f32>

Returns the L2 norm of the points.

Source

pub fn l2_normalize_inplace(&mut self)

Normalizes all points by their L2 norm and modifies the PointSet in place.

Trait Implementations§

Source§

impl<DataType: Clone + Clone> Clone for PointSet<DataType>

Source§

fn clone(&self) -> PointSet<DataType>

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<DataType: Debug + Clone> Debug for PointSet<DataType>

Source§

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

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

impl<'de, DataType> Deserialize<'de> for PointSet<DataType>
where DataType: Deserialize<'de> + Clone,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<DataType: Clone> Display for PointSet<DataType>

Source§

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

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

impl<DataType: Clone + H5Type> Hdf5Serialization for PointSet<DataType>

Source§

type Object = PointSet<DataType>

Source§

fn add_to(&self, group: &mut Group) -> Result<()>

Adds Object to the given HDF5 group.
Source§

fn read_from(group: &Group) -> Result<Self::Object>

Deserializes group into the Object.
Source§

fn label() -> String

Returns the label of Object in the HDF5 file.
Source§

impl<DataType: PartialEq + Clone> PartialEq for PointSet<DataType>

Source§

fn eq(&self, other: &PointSet<DataType>) -> 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<DataType> Serialize for PointSet<DataType>
where DataType: Serialize + Clone,

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<DataType: Eq + Clone> Eq for PointSet<DataType>

Source§

impl<DataType: Clone> StructuralPartialEq for PointSet<DataType>

Auto Trait Implementations§

§

impl<DataType> Freeze for PointSet<DataType>

§

impl<DataType> RefUnwindSafe for PointSet<DataType>
where DataType: RefUnwindSafe,

§

impl<DataType> Send for PointSet<DataType>
where DataType: Send,

§

impl<DataType> Sync for PointSet<DataType>
where DataType: Sync,

§

impl<DataType> Unpin for PointSet<DataType>
where DataType: Unpin,

§

impl<DataType> UnwindSafe for PointSet<DataType>
where DataType: RefUnwindSafe + 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<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§

unsafe 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,