concision-core 0.3.1

this crate implements the core modules for the concision framework
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

/*
    appellation: config <module>
    authors: @FL03
*/
#![cfg(feature = "macros")]

#[doc(hidden)]
#[macro_export]
/// the [`config!`] macro is used to define a configuration for a neural network or its
/// components, automatically implementing the required traits along side various
/// getters and setters for managing the configuration.
macro_rules! config {
    (
        $(#[$attr:meta])*
        $name:ident {$($field:ident: $T:ty $(= $val:expr)?),* $(,)?}
    ) => {
        $(#[$attr])*
        #[cfg_attr(
            feature = "serde",
            derive(serde::Deserialize, serde::Serialize),
            serde(rename_all = "snake_case"),
        )]
        #[repr(C)]
        #[derive(Clone, Debug, Default, PartialEq, PartialOrd)]
        pub struct $name {
            $(pub $field: $T),*
        }

        impl $name {
            config!(@impl $($field: $T $(= $val)?),*);
        }
    };
    (@impl $($field:ident: $T:ty $(= $val:expr)?),* $(,)?) => {
        pub fn new() -> Self {
            Self {
                $($field: Default::default()),*
            }
        }
        paste::paste! {
            $(
                /// returns an immutable reference to the field
                pub const fn $field(&self) -> &$T {
                    &self.$field
                }
                /// return a mutable reference to the field
                pub const fn [<$field _mut>](&mut self) -> &mut $T {
                    &mut self.$field
                }
                /// update the current value of the field and return a mutable reference to self
                pub fn [<set_ $field>](&mut self, value: $T) -> &mut Self {
                    self.$field = value;
                    self
                }
                /// consume the current instance to create another with the given value
                pub fn [<with_ $field>](self, $field: $T) -> Self {
                    Self {
                        $field,
                        ..self
                    }
                }
            )*
        }
    };
}