langdb_clust 0.9.10

use crate::ValidationError;
use std::fmt::Display;

/// Amount of randomness injected into the response.
///
/// Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks.
///
/// Note that even with temperature of 0.0, the results will not be fully deterministic.
#[derive(
    Debug,
    Clone,
    Copy,
    PartialEq,
    PartialOrd,
    serde::Serialize,
    serde::Deserialize,
)]
#[serde(transparent)]
pub struct Temperature {
    value: f32,
}

impl Default for Temperature {
    fn default() -> Self {
        Self {
            value: 1.0,
        }
    }
}

impl Display for Temperature {
    fn fmt(
        &self,
        f: &mut std::fmt::Formatter<'_>,
    ) -> std::fmt::Result {
        write!(f, "{}", self.value)
    }
}

impl Temperature {
    /// Creates a new temperature.
    ///
    /// ## Arguments
    /// - `value` - The value of the temperature.
    ///
    /// ## Errors
    /// It returns a validation error if the value is not in range: `[0.0, 1.0]`.
    pub fn new(value: f32) -> Result<Self, ValidationError<f32>> {
        if !(0.0..=1.0).contains(&value) {
            return Err(ValidationError {
                _type: "Temperature".to_string(),
                expected: "The temperature must be in range: [0.0, 1.0]."
                    .to_string(),
                actual: value,
            });
        }

        Ok(Self {
            value,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn new() {
        let temperature = Temperature::new(0.5);
        assert_eq!(temperature.unwrap().value, 0.5);
    }

    #[test]
    fn validate() {
        assert!(Temperature::new(-0.1).is_err());
        assert!(Temperature::new(0.0).is_ok());
        assert!(Temperature::new(0.5).is_ok());
        assert!(Temperature::new(1.0).is_ok());
        assert!(Temperature::new(1.1).is_err());
    }

    #[test]
    fn default() {
        assert_eq!(Temperature::default().value, 1.0);
    }

    #[test]
    fn display() {
        let temperature = Temperature::new(0.5).unwrap();
        assert_eq!(temperature.to_string(), "0.5");
    }

    #[test]
    fn serialize() {
        let temperature = Temperature::new(0.5).unwrap();
        assert_eq!(
            serde_json::to_string(&temperature).unwrap(),
            "0.5"
        );
    }

    #[test]
    fn deserialize() {
        let temperature = Temperature::new(0.5).unwrap();
        assert_eq!(
            serde_json::from_str::<Temperature>("0.5").unwrap(),
            temperature
        );
    }
}