mahf 0.1.0

A framework for modular construction and evaluation of metaheuristics.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

//! Identifiers to distinguish between different components of the same type.

use std::{any::type_name, marker::PhantomData};

use serde::{ser::SerializeTupleStruct, Serialize, Serializer};
use trait_set::trait_set;

trait_set! {
    /// Collection of traits required by every identifier.
    ///
    /// In general, identifiers should be zero-sized.
    pub trait Identifier = Default + Copy + Clone + Serialize + Send + Sync + 'static;
}

macro_rules! identifier {
    ($name:ident, $doc:tt) => {
        #[derive(Default, Copy, Clone, Serialize)]
        #[doc = $doc]
        pub struct $name;
    };
}

/// A [`PhantomData`] wrapper for [`Identifier`]s, which implements [`Serialize`] using the type name of `I`.
///
/// This makes it possible to infer which identifier was used in serialized [`Component`]s.
///
/// [`Component`]: crate::Component
#[derive(Default, Copy, Clone)]
pub struct PhantomId<I: Identifier>(PhantomData<fn() -> I>);

impl<I: Identifier> Serialize for PhantomId<I> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut id = serializer.serialize_tuple_struct("Id", 1)?;
        id.serialize_field(type_name::<I>())?;
        id.end()
    }
}

#[rustfmt::skip]
mod inner {
    use super::*;

    identifier!(Global, "The default identifier.\n\nIf no identifier is specified, it is assumed the `Global` identifier is used.");

    identifier!(A, "An identifier to distinguish between components of the same type.");
    identifier!(B, "An identifier to distinguish between components of the same type.");
    identifier!(C, "An identifier to distinguish between components of the same type.");
    identifier!(D, "An identifier to distinguish between components of the same type.");
    identifier!(E, "An identifier to distinguish between components of the same type.");

    identifier!(I0, "An identifier to distinguish between components of the same type.");
    identifier!(I1, "An identifier to distinguish between components of the same type.");
    identifier!(I2, "An identifier to distinguish between components of the same type.");
    identifier!(I3, "An identifier to distinguish between components of the same type.");
    identifier!(I4, "An identifier to distinguish between components of the same type.");

    identifier!(Seq, "An identifier to signalize a sequential evaluator.");
    identifier!(Par, "An identifier to signalize a parallel evaluator.");
}

#[doc(inline)]
pub use inner::*;