Struct Analysis 

pub struct Analysis {
    pub features_version: FeaturesVersion,
    /* private fields */
}

Object holding the results of the song’s analysis.

Only use it if you want to have an in-depth look of what is happening behind the scene, or make a distance metric yourself.

Under the hood, it is just an array of f32 holding different numeric features.

For more info on the different features, build the documentation with private items included using cargo doc --document-private-items, and / or read up this document, that contains a description on most of the features, except the chroma ones, which are documented directly in this code.

Fields

features_version: FeaturesVersion

It is bumped every time a change is introduced in the features that makes them incompatible with previous versions.

Implementations

impl Analysis

pub fn new( analysis: Vec<f32>, features_version: FeaturesVersion, ) -> BlissResult<Analysis>

Create a new Analysis object.

Usually not needed, unless you have already computed and stored features somewhere, and need to recreate a Song with an already existing Analysis yourself.

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

Return an ndarray Array1 representing the analysis’ features.

Particularly useful if you want to make a custom distance metric.

pub fn as_vec(&self) -> Vec<f32>

Return a Vec<f32> representing the analysis’ features.

Particularly useful if you want iterate through the values to store them somewhere.

pub fn distance(&self, other: &Analysis) -> f32

Return the distance between the analysis and another analysis, using the default distance for the FeaturesVersion.

Will underperform if used over a large number of songs: for bulk playlist generation, use distance_metric with a bulk-playlist generation function in the playlist module, such as closest_to_songs.

Panics if the analysis’ features have mismatched versions.

Trait Implementations

impl Clone for Analysis

fn clone(&self) -> Analysis

Returns a duplicate 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 Default for Analysis

fn default() -> Analysis

Returns the “default value” for a type.

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 Index<AnalysisIndex> for Analysis

type Output = f32

The returned type after indexing.

fn index(&self, index: AnalysisIndex) -> &f32

Performs the indexing (container[index]) operation.

impl PartialEq for Analysis

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

Equality operator ==.

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

Inequality operator !=.

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 StructuralPartialEq for Analysis