PkmnLib_rs/src/static_data/libraries/type_library.rs

use atomig::Atom;
use hashbrown::HashMap;
use std::fmt::Debug;

use crate::{StringKey, ValueIdentifiable, ValueIdentifier};

/// A unique key that can be used to store a reference to a type. Opaque reference to a byte
/// internally.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Default, Hash, Atom)]
#[repr(C)]
pub struct TypeIdentifier {
    /// The unique internal value.
    val: u8,
}

impl From<u8> for TypeIdentifier {
    fn from(val: u8) -> Self {
        Self { val }
    }
}

impl From<TypeIdentifier> for u8 {
    fn from(id: TypeIdentifier) -> Self {
        id.val
    }
}

/// All data related to types and effectiveness.
pub trait TypeLibrary: Debug + ValueIdentifiable {
    /// Gets the type identifier for a type with a name.
    fn get_type_id(&self, key: &StringKey) -> Option<TypeIdentifier>;

    /// Gets the type name from the type identifier.
    fn get_type_name(&self, t: TypeIdentifier) -> Option<StringKey>;

    /// Gets the effectiveness for a single attacking type against a single defending type.
    fn get_single_effectiveness(&self, attacking: TypeIdentifier, defending: TypeIdentifier) -> f32;

    /// Gets the effectiveness for a single attacking type against an amount of defending types.
    /// This is equivalent to running [`get_single_effectiveness`] on each defending type, and
    /// multiplying the results with each other.
    fn get_effectiveness(&self, attacking: TypeIdentifier, defending: &[TypeIdentifier]) -> f32;

    /// Registers a new type in the library.
    fn register_type(&mut self, name: &StringKey) -> TypeIdentifier;

    /// Sets the effectiveness for an attacking type against a defending type.
    fn set_effectiveness(&mut self, attacking: TypeIdentifier, defending: TypeIdentifier, effectiveness: f32);
}

/// All data related to types and effectiveness.
#[derive(Debug)]
pub struct TypeLibraryImpl {
    /// A unique identifier so we know what value this is.
    identifier: ValueIdentifier,
    /// A list of types
    types: HashMap<StringKey, TypeIdentifier>,
    /// The effectiveness of the different types against each other.
    effectiveness: Vec<Vec<f32>>,
}

impl TypeLibraryImpl {
    /// Instantiates a new type library with a specific capacity.
    pub fn new(capacity: usize) -> Self {
        Self {
            identifier: Default::default(),
            types: HashMap::with_capacity(capacity),
            effectiveness: vec![],
        }
    }
}

impl TypeLibrary for TypeLibraryImpl {
    /// Gets the type identifier for a type with a name.
    fn get_type_id(&self, key: &StringKey) -> Option<TypeIdentifier> {
        self.types.get(key).cloned()
    }

    /// Gets the type name from the type identifier.
    fn get_type_name(&self, t: TypeIdentifier) -> Option<StringKey> {
        for kv in &self.types {
            if *kv.1 == t {
                return Some(kv.0.clone());
            }
        }
        None
    }

    /// Gets the effectiveness for a single attacking type against a single defending type.
    fn get_single_effectiveness(&self, attacking: TypeIdentifier, defending: TypeIdentifier) -> f32 {
        self.effectiveness[(attacking.val - 1) as usize][(defending.val - 1) as usize]
    }

    /// Gets the effectiveness for a single attacking type against an amount of defending types.
    /// This is equivalent to running [`get_single_effectiveness`] on each defending type, and
    /// multiplying the results with each other.
    fn get_effectiveness(&self, attacking: TypeIdentifier, defending: &[TypeIdentifier]) -> f32 {
        let mut e = 1.0;
        for def in defending {
            e *= self.get_single_effectiveness(attacking, *def);
        }
        e
    }

    /// Registers a new type in the library.
    fn register_type(&mut self, name: &StringKey) -> TypeIdentifier {
        let id = TypeIdentifier {
            val: (self.types.len() + 1) as u8,
        };
        self.types.insert(name.clone(), id);
        self.effectiveness.resize((id.val) as usize, vec![]);
        for effectiveness in &mut self.effectiveness {
            effectiveness.resize((id.val) as usize, 1.0)
        }
        id
    }

    /// Sets the effectiveness for an attacking type against a defending type.
    fn set_effectiveness(&mut self, attacking: TypeIdentifier, defending: TypeIdentifier, effectiveness: f32) {
        self.effectiveness[(attacking.val - 1) as usize][(defending.val - 1) as usize] = effectiveness;
    }
}

impl ValueIdentifiable for TypeLibraryImpl {
    fn value_identifier(&self) -> ValueIdentifier {
        self.identifier
    }
}

#[cfg(test)]
pub mod tests {
    use assert_approx_eq::assert_approx_eq;

    use super::*;
    use crate::static_data::libraries::type_library::TypeLibrary;

    pub fn build() -> TypeLibraryImpl {
        let mut lib = TypeLibraryImpl::new(2);

        // Borrow as mut so we can insert
        let w = &mut lib;
        let t0 = w.register_type(&"foo".into());
        let t1 = w.register_type(&"bar".into());
        // Drops borrow as mut

        w.set_effectiveness(t0, t1, 0.5);
        w.set_effectiveness(t1, t0, 2.0);

        lib
    }

    #[test]
    fn add_two_types_retrieve_them() {
        let mut lib = TypeLibraryImpl::new(2);

        // Borrow as mut so we can insert
        let w = &mut lib;
        let t0 = w.register_type(&"foo".into());
        let t1 = w.register_type(&"bar".into());
        // Drops borrow as mut

        // Borrow as read so we can read
        let r = &lib;
        assert_eq!(r.get_type_id(&"foo".into()).unwrap(), t0);
        assert_eq!(r.get_type_id(&"bar".into()).unwrap(), t1);
    }

    #[test]
    fn add_two_types_set_effectiveness_retrieve() {
        let mut lib = TypeLibraryImpl::new(2);

        // Borrow as mut so we can insert
        let w = &mut lib;
        let t0 = w.register_type(&"foo".into());
        let t1 = w.register_type(&"bar".into());
        w.set_effectiveness(t0, t1, 0.5);
        w.set_effectiveness(t1, t0, 2.0);
        // Drops borrow as mut

        // Borrow as read so we can read
        let r = &lib;
        assert_approx_eq!(r.get_single_effectiveness(t0, t1), 0.5);
        assert_approx_eq!(r.get_single_effectiveness(t1, t0), 2.0);
    }

    #[test]
    fn add_two_types_get_aggregate_effectiveness() {
        let mut lib = TypeLibraryImpl::new(2);

        // Borrow as mut so we can insert
        let w = &mut lib;
        let t0 = w.register_type(&"foo".into());
        let t1 = w.register_type(&"bar".into());
        w.set_effectiveness(t0, t1, 0.5);
        w.set_effectiveness(t1, t0, 2.0);
        // Drops borrow as mut

        // Borrow as read so we can read
        let r = &lib;
        assert_approx_eq!(r.get_effectiveness(t0, &[t1, t1]), 0.25);
        assert_approx_eq!(r.get_effectiveness(t1, &[t0, t0]), 4.0);
    }

    #[test]
    fn add_two_types_get_type_name() {
        let mut lib = TypeLibraryImpl::new(2);

        // Borrow as mut so we can insert
        let w = &mut lib;
        let t0 = w.register_type(&"foo".into());
        let t1 = w.register_type(&"bar".into());
        // Drops borrow as mut

        // Borrow as read so we can read
        let r = &lib;
        assert_eq!(r.get_type_name(t0).unwrap(), "foo".into());
        assert_eq!(r.get_type_name(t1).unwrap(), "bar".into());
    }
}