Enum hpo::similarity::Builtins

pub enum Builtins {
    Distance(InformationContentKind),
    GraphIc(InformationContentKind),
    InformationCoefficient(InformationContentKind),
    Jc(InformationContentKind),
    Lin(InformationContentKind),
    Mutation(InformationContentKind),
    Relevance(InformationContentKind),
    Resnik(InformationContentKind),
}

Contains similarity methods for the standard built-in algorithms

For more details about each algorithm, check the defaults description.

Examples

use hpo::{Ontology, HpoSet};
use hpo::term::{InformationContentKind, HpoGroup};
use hpo::similarity::{Builtins, StandardCombiner};

fn set1(ontology: &Ontology) -> HpoSet {
// ...
}

fn set2(ontology: &Ontology) -> HpoSet {
// ...
}

let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
let set_1 = set1(&ontology);
let set_2 = set2(&ontology);

let sim_method = Builtins::GraphIc(InformationContentKind::Omim);

let similarity = set_1.similarity(
    &set_2,
    sim_method,
    StandardCombiner::default()
);

Variants

Distance(InformationContentKind)

Distance - based similarity

GraphIc(InformationContentKind)

GraphIc - based similarity

InformationCoefficient(InformationContentKind)

InformationCoefficient - based similarity

Jc(InformationContentKind)

Jiang & Conrath - based similarity

Lin(InformationContentKind)

Lin - based similarity

Mutation(InformationContentKind)

Mutation - based similarity

Relevance(InformationContentKind)

Relevance - based similarity

Resnik(InformationContentKind)

Resnik - based similarity

Implementations

impl Builtins

pub fn new(method: &str, kind: InformationContentKind) -> HpoResult<Self>

Constructs a new Builtins struct from a str

This method is useful to get a Similarity algorithm from a user provided string

use hpo::term::InformationContentKind;
use hpo::similarity::Builtins;

let sim_method = Builtins::new("graphic", InformationContentKind::Omim);
assert!(sim_method.is_ok());

let sim_method = Builtins::new("does-not-exist", InformationContentKind::Omim);
assert!(sim_method.is_err());

Errors

Returns an HpoError::DoesNotExist error if no similary method with the given name exists

Trait Implementations

impl Clone for Builtins

fn clone(&self) -> Builtins

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builtins

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

Formats the value using the given formatter.

impl Hash for Builtins

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Builtins

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Similarity for Builtins

fn calculate(&self, a: &HpoTerm<'_>, b: &HpoTerm<'_>) -> f32

calculates the actual similarity between term a and term b

impl Copy for Builtins

impl Eq for Builtins

impl StructuralPartialEq for Builtins