QuantumClusterer

Struct QuantumClusterer 

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

Quantum-Inspired Clustering Algorithm

This structure implements a quantum-enhanced version of k-means clustering that uses quantum superposition for centroid representation and quantum interference effects to improve convergence. The algorithm maintains both classical and quantum representations of cluster centroids.

§Features

  • Quantum superposition for exploring multiple centroid configurations
  • Quantum interference effects for enhanced convergence
  • Quantum-enhanced distance calculations
  • Configurable quantum circuit depth and superposition states

§Example

use scirs2_core::ndarray::Array2;
use scirs2_spatial::quantum_inspired::algorithms::QuantumClusterer;

let points = Array2::from_shape_vec((6, 2), vec![
    0.0, 0.0, 1.0, 0.0, 0.0, 1.0,
    5.0, 5.0, 6.0, 5.0, 5.0, 6.0
]).unwrap();

let mut clusterer = QuantumClusterer::new(2)
    .with_quantum_depth(4)
    .with_superposition_states(16)
    .with_max_iterations(50);

let (centroids, assignments) = clusterer.fit(&points.view()).unwrap();

Implementations§

Source§

impl QuantumClusterer

Source

pub fn new(num_clusters: usize) -> Self

Create new quantum clusterer

§Arguments
  • num_clusters - Number of clusters to find
§Returns

A new QuantumClusterer with default configuration

Source

pub fn with_quantum_depth(self, depth: usize) -> Self

Configure quantum circuit depth

Higher depth allows for more complex quantum operations but increases computational cost. Typical values range from 3-10.

§Arguments
  • depth - Quantum circuit depth
Source

pub fn with_superposition_states(self, states: usize) -> Self

Configure superposition states

Number of quantum superposition states to maintain during clustering. More states provide better exploration but increase memory usage.

§Arguments
  • states - Number of superposition states
Source

pub fn with_max_iterations(self, max_iter: usize) -> Self

Configure maximum iterations

Maximum number of iterations for the quantum clustering algorithm.

§Arguments
  • max_iter - Maximum number of iterations
Source

pub fn with_tolerance(self, tolerance: f64) -> Self

Configure convergence tolerance

Algorithm stops when the change in cost function is below this threshold.

§Arguments
  • tolerance - Convergence tolerance
Source

pub fn fit( &mut self, points: &ArrayView2<'_, f64>, ) -> SpatialResult<(Array2<f64>, Array1<usize>)>

Fit quantum clustering to data points

Performs quantum-enhanced k-means clustering on the input points. Returns cluster centroids and point assignments.

§Arguments
  • points - Input points to cluster (n_points × n_dims)
§Returns

Tuple of (centroids, assignments) where:

  • centroids: Array of cluster centers (num_clusters × n_dims)
  • assignments: Cluster assignment for each point (n_points,)
§Errors

Returns error if number of points is less than number of clusters

Source

pub fn predict( &self, points: &ArrayView2<'_, f64>, ) -> SpatialResult<Array1<usize>>

Predict cluster assignments for new points

Uses the fitted quantum centroids to assign cluster labels to new points.

§Arguments
  • points - New points to classify
§Returns

Cluster assignments for the new points

§Errors

Returns error if the clusterer hasn’t been fitted yet

Source

pub fn num_clusters(&self) -> usize

Get number of clusters

Source

pub fn quantum_depth(&self) -> usize

Get quantum circuit depth

Source

pub fn superposition_states(&self) -> usize

Get number of superposition states

Source

pub fn is_fitted(&self) -> bool

Check if the clusterer has been fitted

Source

pub fn quantum_state(&self) -> Option<&QuantumState>

Get the quantum centroid state (if fitted)

Trait Implementations§

Source§

impl Clone for QuantumClusterer

Source§

fn clone(&self) -> QuantumClusterer

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 Debug for QuantumClusterer

Source§

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

Formats the value using the given formatter. 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<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