Struct HierarchicalModel 

pub struct HierarchicalModel {
    pub linkage: Array2<f64>,
    pub n_observations: usize,
    pub method: String,
    pub labels: Option<Vec<String>>,
}

Hierarchical clustering result that can be serialized

Fields

linkage: Array2<f64>

Linkage matrix

n_observations: usize

Number of original observations

method: String

Method used for linkage

labels: Option<Vec<String>>

Dendrogram labels (optional)

Implementations

impl HierarchicalModel

pub fn new( linkage: Array2<f64>, n_observations: usize, method: String, labels: Option<Vec<String>>, ) -> Self

Create a new hierarchical clustering model

pub fn to_newick(&self) -> Result<String>

Export dendrogram to Newick format

pub fn to_json_tree(&self) -> Result<Value>

Export dendrogram to JSON format

Trait Implementations

impl Clone for HierarchicalModel

fn clone(&self) -> HierarchicalModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HierarchicalModel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HierarchicalModel

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl SerializableModel for HierarchicalModel

fn save_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save the model to a file

fn save_to_writer<W: Write>(&self, writer: W) -> Result<()>

Save the model to a writer

fn save_to_file_compressed<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save the model to a file with compression

fn load_from_file_compressed<P: AsRef<Path>>(path: P) -> Result<Self>

Load the model from a compressed file

fn load_from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Load the model from a file

fn load_from_reader<R: Read>(reader: R) -> Result<Self>

Load the model from a reader

impl Serialize for HierarchicalModel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.