Struct ScoreAnswer 

#[non_exhaustive]
pub struct ScoreAnswer {
    pub score: f64,
    pub confidence: f64,
    pub legend: IndexMap<String, Content>,
    pub probabilities: IndexMap<String, f64>,
}

The answer to a ScoreQuestion.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

score: f64

Probability-weighted level, from 0 to the top level; can land between levels.

confidence: f64

How concentrated the distribution is, from 0 to 1.

legend: IndexMap<String, Content>

Level number (as a string key) to the level’s description.

probabilities: IndexMap<String, f64>

Level number (as a string key) to its probability.

Implementations

impl ScoreAnswer

pub fn new( score: f64, confidence: f64, levels: impl IntoIterator<Item = impl Into<Content>>, probabilities: impl IntoIterator<Item = f64>, ) -> Self

An answer over levels (in order) with one probability per level, for fixtures and tests.

pub fn levels(&self) -> usize

Number of levels the question had.

pub fn level_probabilities(&self) -> Vec<f64>

Probability of each level, indexed by level number. Levels the response has no probability for count as 0.

pub fn most_likely_level(&self) -> Option<usize>

The single most probable level, or None when there are no levels.

pub fn nearest_level(&self) -> usize

The score rounded to the nearest level, for code that needs one outcome.

pub fn normalized(&self) -> f64

The score divided by the top level, from 0 to 1, so scores with different numbers of levels can be weighted and combined.

pub fn level_description(&self, level: usize) -> Option<&Content>

The description of level, as the question defined it.

Trait Implementations

impl Clone for ScoreAnswer

fn clone(&self) -> ScoreAnswer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScoreAnswer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScoreAnswer

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ScoreAnswer> for Answer

fn from(answer: ScoreAnswer) -> Self

Converts to this type from the input type.

impl PartialEq for ScoreAnswer

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

Equality operator ==.

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

Inequality operator !=.

impl ReadAnswer for ScoreAnswer

type Output<'a> = &'a ScoreAnswer

What SystemOneResponse::answer returns for this key.

fn read<'a>( id: &str, answer: &'a Answer, ) -> Result<&'a ScoreAnswer, AnswerError>

Reads the answer to question id, failing when it has the wrong kind or content.

impl Serialize for ScoreAnswer

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 ScoreAnswer