Struct pointcloud::SimpleNamedCloud

pub struct SimpleNamedCloud<D, N> { /* fields omitted */ }

Simply shoves together a point cloud and a name set, for a modular name system

Implementations

impl<D: PointCloud, N: NamedSet> SimpleNamedCloud<D, N>

pub fn new(data: D, names: N) -> Self

Creates a new one

Trait Implementations

impl<D: Debug, N: Debug> Debug for SimpleNamedCloud<D, N>

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

Formats the value using the given formatter.

impl<D: PointCloud, N: NamedSet> PointCloud for SimpleNamedCloud<D, N>

type Metric = D::Metric

Underlying metric this point cloud uses

type Point = D::Point

The derefrenced, raw point. Think f32

type PointRef = D::PointRef

A reference to a point. Think &’a f32

type Metadata = D::Metadata

Underlying metadata

type MetaSummary = D::MetaSummary

A summary of the underlying metadata

type Label = D::Label

The label type. Summary of a set of labels

type LabelSummary = D::LabelSummary

Summary of a set of labels

fn dim(&self) -> usize

The dimension of the underlying data

fn len(&self) -> usize

The number of samples this cloud covers

fn is_empty(&self) -> bool

If this is empty

fn reference_indexes(&self) -> Vec<usize>

Indexes used for access

fn point<'a, 'b: 'a>(&'b self, i: usize) -> PointCloudResult<Self::PointRef>

Gets a point from this dataset

fn metadata(&self, pn: usize) -> PointCloudResult<Option<&Self::Metadata>>

Expensive metadata object for the sample

fn metasummary(
    &self,
    pns: &[usize]
) -> PointCloudResult<SummaryCounter<Self::MetaSummary>>

Expensive metadata summary over the samples

fn label(&self, pn: usize) -> PointCloudResult<Option<&Self::Label>>

Grabs a label reference. Supports errors (the label could be remote), and partially labeled datasets with the option.

fn label_summary(
    &self,
    pns: &[usize]
) -> PointCloudResult<SummaryCounter<Self::LabelSummary>>

Grabs a label summary of a set of indexes.

fn name(&self, pi: usize) -> PointCloudResult<String>

Grabs the name of the point. Returns an error if the access errors out, and a None if the name is unknown

fn index(&self, pn: &str) -> PointCloudResult<usize>

Converts a name to an index you can use

fn names(&self) -> Vec<String>

Gather’s all valid known names

fn point_dense_array(&self, index: usize) -> PointCloudResult<Array1<f32>>

Returns a dense array

fn points_dense_matrix(
    &self,
    indexes: &[usize]
) -> PointCloudResult<Array2<f32>>

Returns a dense array

fn distances_to_point_index(
    &self,
    i: usize,
    indexes: &[usize]
) -> PointCloudResult<Vec<f32>>

The main distance function. This paralizes if there are more than 100 points.

fn distances_to_point<T: Deref<Target = Self::Point> + Send + Sync>(
    &self,
    x: &T,
    indexes: &[usize]
) -> PointCloudResult<Vec<f32>>

The main distance function. This paralizes if there are more than 100 points.

fn moment_1(&self, indexes: &[usize]) -> PointCloudResult<Vec<f32>> where
    f32: AddAssign, 

The first moment of the specified vectors. See wikipedia.

fn moment_2(&self, indexes: &[usize]) -> PointCloudResult<Vec<f32>> where
    f32: Mul<Output = f32> + AddAssign, 

The second moment of the specified vectors. See wikipedia.