Struct Analysis

pub struct Analysis {
    pub id: AnalysisId,
    pub features: [f64; 20],
}

This struct holds the Analysis of a particular [Song].

An Analysis is the features extracted by the mecomp-analysis library and are used for recommendations (nearest neighbor search) and Collection generation (clustering).

Fields

id: AnalysisId

the unique identifier for this Analysis.

features: [f64; 20]

The [Song]’s audio features.

Implementations

impl Analysis

pub async fn create<C: Connection>( db: &Surreal<C>, song_id: SongId, analysis: Self, ) -> StorageResult<Option<Self>>

create a new analysis for the given song

If an analysis already exists for the song, this will return None.

pub async fn read<C: Connection>( db: &Surreal<C>, id: AnalysisId, ) -> StorageResult<Option<Self>>

pub async fn read_all<C: Connection>( db: &Surreal<C>, ) -> StorageResult<Vec<Self>>

pub async fn read_for_song<C: Connection>( db: &Surreal<C>, song_id: SongId, ) -> StorageResult<Option<Self>>

Read the analysis for a song

If the song does not have an analysis, this will return None.

pub async fn read_for_songs<C: Connection>( db: &Surreal<C>, song_ids: Vec<SongId>, ) -> StorageResult<Vec<Option<Self>>>

Read the analysis for OneOrMany song(s)

Needed for clustering(?)

We return a Vec<Option>, where None means the song doesn’t have an analysis, so that it’s up to the caller to handle songs without analyses.

pub async fn read_song<C: Connection>( db: &Surreal<C>, id: AnalysisId, ) -> StorageResult<Song>

Read the song for an analysis

pub async fn read_songs<C: Connection>( db: &Surreal<C>, ids: OneOrMany<AnalysisId>, ) -> StorageResult<OneOrMany<Song>>

Read the song for OneOrMany analyses

needed to convert a list of analyses (such as what we get from nearest_neighbors) into a list of songs

pub async fn read_songs_without_analysis<C: Connection>( db: &Surreal<C>, ) -> StorageResult<Vec<Song>>

Get all the songs that don’t have an analysis

pub async fn delete<C: Connection>( db: &Surreal<C>, id: AnalysisId, ) -> StorageResult<Option<Self>>

Delete an analysis

pub async fn nearest_neighbors<C: Connection>( db: &Surreal<C>, id: AnalysisId, n: u32, ) -> StorageResult<Vec<Self>>

Find the n nearest neighbors to an analysis

pub async fn nearest_neighbors_to_many<C: Connection>( db: &Surreal<C>, ids: Vec<AnalysisId>, n: u32, ) -> StorageResult<Vec<Self>>

Find the n nearest neighbors to a list of analyses

The provided analyses should not be included in the results

impl Analysis

pub fn generate_id() -> AnalysisId

Trait Implementations

impl Clone for Analysis

fn clone(&self) -> Analysis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Analysis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Analysis

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Analysis> for Analysis

fn from(analysis: &Analysis) -> Self

Converts to this type from the input type.

impl From<Analysis> for Analysis

fn from(analysis: Analysis) -> Self

Converts to this type from the input type.

impl PartialEq for Analysis

fn eq(&self, other: &Analysis) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Analysis

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Table for Analysis

const TABLE_NAME: &'static str = "analysis"

fn init_table<C: Connection>( db: &Surreal<C>, ) -> impl Future<Output = Result<()>> + Send

impl StructuralPartialEq for Analysis