moors 0.2.10

Solving multi-objective optimization problems using genetic algorithms.
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217

#[macro_export]
macro_rules! define_algorithm_and_builder {
    // === API: with override_build_method  ===
    (
        $(#[$meta:meta])*
        $algorithm:ident, $selector:ty, $survivor:ty
        $(, selection_args = [ $( $larg:ident : $lty:ty ),* $(,)? ])?
        $(, survival_args  = [ $( $sarg:ident : $sty:ty ),* $(,)? ])?
        $(, shared_survival_args = [ $( $ss:ident : $ssty:ty ),* $(,)? ])?
        , override_build_method = $ov:tt
        $(,)?
    ) => {
        define_algorithm_and_builder! {
            @impl
            ($(#[$meta])*) $algorithm, $selector, $survivor,
            selection: [ $( $( $larg : $lty ),* )? ],
            survival:  [ $( $( $sarg : $sty ),* )? ],
            shared:    [ $( $( $ss   : $ssty),* )? ],
            override_build: $ov
        }
    };

    // === API: w.o override_build_method (default = false) ===
    (
        $(#[$meta:meta])*
        $algorithm:ident, $selector:ty, $survivor:ty
        $(, selection_args = [ $( $larg:ident : $lty:ty ),* $(,)? ])?
        $(, survival_args  = [ $( $sarg:ident : $sty:ty ),* $(,)? ])?
        $(, shared_survival_args = [ $( $ss:ident : $ssty:ty ),* $(,)? ])?
        $(,)? // trailing comma opcional
    ) => {
        define_algorithm_and_builder!(
            $(#[$meta])*
            $algorithm, $selector, $survivor,
            selection_args = [ $( $( $larg : $lty ),* )? ],
            survival_args  = [ $( $( $sarg : $sty ),* )? ],
            shared_survival_args = [ $( $( $ss : $ssty ),* )? ],
            override_build_method = false
        );
    };

    // ============================ Impl block =============================
    (@impl
        ($(#[$meta:meta])*) $algorithm:ident, $selector:ty, $survivor:ty,
        selection: [ $( $larg:ident : $lty:ty ),* ],
        survival:  [ $( $sarg:ident : $sty:ty ),* ],
        shared:    [ $( $ss:ident   : $ssty:ty ),* ],
        override_build: $ov:tt
    ) => {
        ::paste::paste! {
            $(#[$meta])*
            pub type $algorithm<S, Cross, Mut, F, G> =
                $crate::algorithms::GeneticAlgorithm<
                    S, $selector, $survivor, Cross, Mut, F, G
                >;

            // -------- Builder -------------------------------------------------
            pub struct [<$algorithm Builder>]<S, Cross, Mut, F, G>
            where
                S: $crate::operators::SamplingOperator,
                $selector: $crate::operators::SelectionOperator<FDim = F::Dim>,
                $survivor: $crate::operators::SurvivalOperator<FDim = F::Dim>,
                Cross: $crate::operators::CrossoverOperator,
                Mut: $crate::operators::MutationOperator,
                F: $crate::evaluator::FitnessFn,
                G: $crate::evaluator::ConstraintsFn,
            {
                inner: $crate::algorithms::AlgorithmBuilder<
                    S, $selector, $survivor, Cross, Mut, F, G
                >,

                $( $larg: ::core::option::Option<$lty>, )*
                $( $sarg: ::core::option::Option<$sty>, )*
            }

            impl<S, Cross, Mut, F, G> ::core::default::Default
                for [<$algorithm Builder>]<S, Cross, Mut, F, G>
            where
                S: $crate::operators::SamplingOperator,
                $selector: $crate::operators::SelectionOperator<FDim = F::Dim>,
                $survivor: $crate::operators::SurvivalOperator<FDim = F::Dim>,
                Cross: $crate::operators::CrossoverOperator,
                Mut: $crate::operators::MutationOperator,
                F: $crate::evaluator::FitnessFn,
                G: $crate::evaluator::ConstraintsFn,
                $crate::algorithms::AlgorithmBuilder<
                    S, $selector, $survivor, Cross, Mut, F, G
                >: ::core::default::Default,
            {
                fn default() -> Self {
                    Self {
                        inner: ::core::default::Default::default(),
                        $( $larg: ::core::option::Option::None, )*
                        $( $sarg: ::core::option::Option::None, )*
                    }
                }
            }

            impl<S, Cross, Mut, F, G> [<$algorithm Builder>]<S, Cross, Mut, F, G>
            where
                S: $crate::operators::SamplingOperator,
                $selector: $crate::operators::SelectionOperator<FDim = F::Dim>,
                $survivor: $crate::operators::SurvivalOperator<FDim = F::Dim>,
                Cross: $crate::operators::CrossoverOperator,
                Mut: $crate::operators::MutationOperator,
                F: $crate::evaluator::FitnessFn,
                G: $crate::evaluator::ConstraintsFn,
            {
                // === Public setters (selection/survival) ====================
                $(
                    #[inline]
                    pub fn $larg(mut self, v: $lty) -> Self {
                        self.$larg = ::core::option::Option::Some(v);
                        self
                    }
                )*
                $(
                    #[inline]
                    pub fn $sarg(mut self, v: $sty) -> Self {
                        self.$sarg = ::core::option::Option::Some(v);
                        self
                    }
                )*

                // === Inner Forwards ============================
                #[inline] pub fn sampler(mut self, v: S) -> Self { self.inner = self.inner.sampler(v); self }
                #[inline] pub fn crossover(mut self, v: Cross) -> Self { self.inner = self.inner.crossover(v); self }
                #[inline] pub fn mutation(mut self, v: Mut) -> Self { self.inner = self.inner.mutation(v); self }
                #[inline] pub fn repair(mut self, v: impl $crate::operators::RepairOperator + 'static) -> Self { self.inner = self.inner.repair(v); self }
                #[inline] pub fn selector(mut self, v: $selector) -> Self { self.inner = self.inner.selector(v); self }
                #[inline] pub fn survivor(mut self, v: $survivor) -> Self { self.inner = self.inner.survivor(v); self }
                #[inline] pub fn fitness_fn(mut self, v: F) -> Self { self.inner = self.inner.fitness_fn(v); self }
                #[inline] pub fn constraints_fn(mut self, v: G) -> Self { self.inner = self.inner.constraints_fn(v); self }
                #[inline] pub fn duplicates_cleaner(mut self, v: impl $crate::duplicates::PopulationCleaner + 'static) -> Self { self.inner = self.inner.duplicates_cleaner(v); self }
                #[inline] pub fn num_vars(mut self, v: usize) -> Self { self.inner = self.inner.num_vars(v); self }
                #[inline] pub fn population_size(mut self, v: usize) -> Self { self.inner = self.inner.population_size(v); self }
                #[inline] pub fn num_offsprings(mut self, v: usize) -> Self { self.inner = self.inner.num_offsprings(v); self }
                #[inline] pub fn num_iterations(mut self, v: usize) -> Self { self.inner = self.inner.num_iterations(v); self }
                #[inline] pub fn mutation_rate(mut self, v: f64) -> Self { self.inner = self.inner.mutation_rate(v); self }
                #[inline] pub fn crossover_rate(mut self, v: f64) -> Self { self.inner = self.inner.crossover_rate(v); self }
                #[inline] pub fn keep_infeasible(mut self, v: bool) -> Self { self.inner = self.inner.keep_infeasible(v); self }
                #[inline] pub fn verbose(mut self, v: bool) -> Self { self.inner = self.inner.verbose(v); self }
                #[inline] pub fn seed(mut self, v: u64) -> Self { self.inner = self.inner.seed(v); self }

                // === Build =====================================================
                pub fn build(mut self) -> ::core::result::Result<
                    $algorithm<S, Cross, Mut, F, G>,
                    $crate::algorithms::AlgorithmBuilderError
                > {
                    if $ov {
                        // We do not rebuild selector/survivor: use what is already set
                        return self.inner.build();
                    }

                    // --- Selector::new( selection_args... ) ---
                    $(
                        let $larg = self.$larg.ok_or(
                            $crate::algorithms::AlgorithmBuilderError::UninitializedField(
                                ::core::concat!(::core::module_path!(), "::", ::core::stringify!($larg))
                            )
                        )?;
                    )*
                    let selector_val = define_algorithm_and_builder!(@call_selector $selector ; ( $( $larg ),* ));
                    self.inner = self.inner.selector(selector_val);

                    // --- Survivor::new( shared..., survival_args... ) ---
                    $(
                        let $ss = self.inner.[<$ss>].ok_or(
                            $crate::algorithms::AlgorithmBuilderError::UninitializedField(
                                ::core::concat!(::core::module_path!(), "::", ::core::stringify!($ss))
                            )
                        )?;
                    )*
                    $(
                        let $sarg = self.$sarg.ok_or(
                            $crate::algorithms::AlgorithmBuilderError::UninitializedField(
                                ::core::concat!(::core::module_path!(), "::", ::core::stringify!($sarg))
                            )
                        )?;
                    )*

                    let survivor_val = define_algorithm_and_builder!(
                        @call_survivor $survivor ; ( $( $sarg ),* ) ( $( $ss ),* )
                    );

                    self.inner = self.inner.survivor(survivor_val);

                    self.inner.build()
                }
            }
        }
    };

    (@call_selector $ty:ty ; () ) => { < $ty >::new() };
    (@call_selector $ty:ty ; ( $( $a:ident ),+ ) ) => { < $ty >::new( $( $a ),+ ) };

    // 0/0
    (@call_survivor $ty:ty ; () () ) => {
        < $ty >::new()
    };

    // A/0  (A = survival_args)
    (@call_survivor $ty:ty ; ( $( $a:ident ),+ ) () ) => {
        < $ty >::new( $( $a ),+ )
    };

    // 0/B  (B = shared_survival_args)
    (@call_survivor $ty:ty ; () ( $( $b:ident ),+ ) ) => {
        < $ty >::new( $( $b ),+ )
    };

    // A/B  (survival first, then shared)
    (@call_survivor $ty:ty ; ( $( $a:ident ),+ ) ( $( $b:ident ),+ ) ) => {
        < $ty >::new( $( $a ),+ , $( $b ),+ )
    };

}