optirs-core 0.3.1

OptiRS core optimization algorithms and utilities
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
// Optimizer composition framework
//
// This module provides compositions of optimizers to create more sophisticated
// optimization strategies. It includes three main types of compositions:
//
// 1. **Sequential**: Apply multiple optimizers in sequence
// 2. **Parallel**: Apply different optimizers to different parameter groups
// 3. **Chained**: Wrap an optimizer with another (similar to Lookahead wrapping other optimizers)

use crate::error::{OptimError, Result};
use crate::optimizers::Optimizer;
use scirs2_core::ndarray::{Array, Dimension, ScalarOperand};
use scirs2_core::numeric::Float;
use std::fmt::Debug;

/// A sequential composition of optimizers
///
/// This applies multiple optimizers in sequence to the same parameters.
/// Each optimizer's output becomes the input to the next optimizer.
///
/// # Example
///
/// ```
/// use scirs2_core::ndarray::Array1;
/// use optirs_core::optimizer_composition::SequentialOptimizer;
/// use optirs_core::optimizers::{SGD, Adam, Optimizer};
///
/// // Create optimizers
/// let sgd = SGD::new(0.1);
/// let adam = Adam::new(0.01);
///
/// // Combine them sequentially
/// let mut seq_optimizer = SequentialOptimizer::new(vec![
///     Box::new(sgd),
///     Box::new(adam),
/// ]);
///
/// // Use the sequential optimizer
/// let params = Array1::zeros(5);
/// let gradients = Array1::ones(5);
/// let updated_params = seq_optimizer.step(&params, &gradients).expect("unwrap failed");
/// ```
pub struct SequentialOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    /// List of optimizers to apply in sequence
    optimizers: Vec<Box<dyn Optimizer<A, D>>>,
}

impl<A, D> SequentialOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    /// Create a new sequential optimizer
    ///
    /// # Arguments
    ///
    /// * `optimizers` - List of optimizers to apply in sequence
    pub fn new(optimizers: Vec<Box<dyn Optimizer<A, D>>>) -> Self {
        Self { optimizers }
    }

    /// Add an optimizer to the sequence
    ///
    /// # Arguments
    ///
    /// * `optimizer` - The optimizer to add
    pub fn add_optimizer(&mut self, optimizer: Box<dyn Optimizer<A, D>>) {
        self.optimizers.push(optimizer);
    }

    /// Get the number of optimizers in the sequence
    pub fn num_optimizers(&self) -> usize {
        self.optimizers.len()
    }

    /// Get a reference to an optimizer by index
    ///
    /// # Arguments
    ///
    /// * `index` - The index of the optimizer
    ///
    /// # Returns
    ///
    /// A reference to the optimizer at the given index, or None if out of bounds
    pub fn get_optimizer(&self, index: usize) -> Option<&dyn Optimizer<A, D>> {
        if index < self.optimizers.len() {
            Some(self.optimizers[index].as_ref())
        } else {
            None
        }
    }

    /// Get a mutable reference to an optimizer by index
    ///
    /// # Arguments
    ///
    /// * `index` - The index of the optimizer
    ///
    /// # Returns
    ///
    /// A mutable reference to the optimizer at the given index, or None if out of bounds
    pub fn get_optimizer_mut(&mut self, index: usize) -> Option<&mut dyn Optimizer<A, D>> {
        if index < self.optimizers.len() {
            Some(self.optimizers[index].as_mut())
        } else {
            None
        }
    }
}

impl<A, D> Optimizer<A, D> for SequentialOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    fn step(&mut self, params: &Array<A, D>, gradients: &Array<A, D>) -> Result<Array<A, D>> {
        // Check if we have any optimizers
        if self.optimizers.is_empty() {
            return Err(OptimError::InvalidConfig(
                "SequentialOptimizer has no optimizers".to_string(),
            ));
        }

        // Start with the initial parameters
        let mut current_params = params.clone();

        // Apply each optimizer in sequence
        for optimizer in &mut self.optimizers {
            current_params = optimizer.step(&current_params, gradients)?;
        }

        Ok(current_params)
    }

    fn get_learning_rate(&self) -> A {
        // Return the learning rate of the first optimizer, or a default if empty
        if let Some(optimizer) = self.optimizers.first() {
            optimizer.get_learning_rate()
        } else {
            A::from(0.01).expect("unwrap failed") // Default learning rate
        }
    }

    fn set_learning_rate(&mut self, learningrate: A) {
        // Set the learning _rate for all optimizers
        for optimizer in &mut self.optimizers {
            optimizer.set_learning_rate(learningrate);
        }
    }
}

/// A struct for assigning parameters to specific groups for parallel optimization
pub struct ParameterGroup<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    /// The parameters in this group
    pub params: Array<A, D>,
    /// The index of the optimizer to use for this group
    pub optimizerindex: usize,
}

impl<A, D> ParameterGroup<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    /// Create a new parameter group
    ///
    /// # Arguments
    ///
    /// * `params` - The parameters in this group
    /// * `optimizerindex` - The index of the optimizer to use for this group
    pub fn new(params: Array<A, D>, optimizerindex: usize) -> Self {
        Self {
            params,
            optimizerindex,
        }
    }
}

/// A parallel composition of optimizers
///
/// This applies different optimizers to different parameter groups.
/// Each group of parameters is updated using its assigned optimizer.
///
/// # Example
///
/// ```
/// use scirs2_core::ndarray::Array1;
/// use optirs_core::optimizer_composition::{ParallelOptimizer, ParameterGroup};
/// use optirs_core::optimizers::{SGD, Adam, Optimizer};
///
/// // Create optimizers
/// let sgd = SGD::new(0.1);
/// let adam = Adam::new(0.01);
///
/// // Create parameter groups
/// let params1 = Array1::zeros(3);
/// let params2 = Array1::zeros(5);
///
/// let group1 = ParameterGroup::new(params1, 0); // Use SGD
/// let group2 = ParameterGroup::new(params2, 1); // Use Adam
///
/// // Combine them in parallel
/// let mut parallel_optimizer = ParallelOptimizer::new(
///     vec![Box::new(sgd), Box::new(adam)],
///     vec![group1, group2],
/// );
///
/// // The step method will update all parameter groups using their assigned optimizers
/// // (In a real use case, you'd provide the corresponding gradients)
/// ```
pub struct ParallelOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    /// List of optimizers to apply to different parameter groups
    optimizers: Vec<Box<dyn Optimizer<A, D>>>,
    /// Groups of parameters with their assigned optimizer indices
    parameter_groups: Vec<ParameterGroup<A, D>>,
}

impl<A, D> ParallelOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    /// Create a new parallel optimizer
    ///
    /// # Arguments
    ///
    /// * `optimizers` - List of optimizers to use
    /// * `parameter_groups` - Groups of parameters with their assigned optimizer indices
    pub fn new(
        optimizers: Vec<Box<dyn Optimizer<A, D>>>,
        parameter_groups: Vec<ParameterGroup<A, D>>,
    ) -> Self {
        Self {
            optimizers,
            parameter_groups,
        }
    }

    /// Add an optimizer
    ///
    /// # Arguments
    ///
    /// * `optimizer` - The optimizer to add
    ///
    /// # Returns
    ///
    /// The index of the added optimizer
    pub fn add_optimizer(&mut self, optimizer: Box<dyn Optimizer<A, D>>) -> usize {
        let index = self.optimizers.len();
        self.optimizers.push(optimizer);
        index
    }

    /// Add a parameter group
    ///
    /// # Arguments
    ///
    /// * `params` - The parameters in this group
    /// * `optimizerindex` - The index of the optimizer to use for this group
    ///
    /// # Returns
    ///
    /// Result with the index of the added parameter group, or an error if the optimizer index is invalid
    pub fn add_parameter_group(
        &mut self,
        params: Array<A, D>,
        optimizerindex: usize,
    ) -> Result<usize> {
        // Check if the optimizer _index is valid
        if optimizerindex >= self.optimizers.len() {
            return Err(OptimError::InvalidConfig(format!(
                "Invalid optimizer _index: {}. Only {} optimizers available.",
                optimizerindex,
                self.optimizers.len()
            )));
        }

        let _index = self.parameter_groups.len();
        self.parameter_groups
            .push(ParameterGroup::new(params, optimizerindex));
        Ok(_index)
    }

    /// Get the number of optimizers
    pub fn num_optimizers(&self) -> usize {
        self.optimizers.len()
    }

    /// Get the number of parameter groups
    pub fn num_parameter_groups(&self) -> usize {
        self.parameter_groups.len()
    }

    /// Get a reference to an optimizer by index
    ///
    /// # Arguments
    ///
    /// * `index` - The index of the optimizer
    ///
    /// # Returns
    ///
    /// A reference to the optimizer at the given index, or None if out of bounds
    pub fn get_optimizer(&self, index: usize) -> Option<&dyn Optimizer<A, D>> {
        if index < self.optimizers.len() {
            Some(self.optimizers[index].as_ref())
        } else {
            None
        }
    }

    /// Get a mutable reference to an optimizer by index
    ///
    /// # Arguments
    ///
    /// * `index` - The index of the optimizer
    ///
    /// # Returns
    ///
    /// A mutable reference to the optimizer at the given index, or None if out of bounds
    pub fn get_optimizer_mut(&mut self, index: usize) -> Option<&mut dyn Optimizer<A, D>> {
        if index < self.optimizers.len() {
            Some(self.optimizers[index].as_mut())
        } else {
            None
        }
    }

    /// Get a reference to a parameter group by index
    ///
    /// # Arguments
    ///
    /// * `index` - The index of the parameter group
    ///
    /// # Returns
    ///
    /// A reference to the parameter group at the given index, or None if out of bounds
    pub fn get_parameter_group(&self, index: usize) -> Option<&ParameterGroup<A, D>> {
        self.parameter_groups.get(index)
    }

    /// Get a mutable reference to a parameter group by index
    ///
    /// # Arguments
    ///
    /// * `index` - The index of the parameter group
    ///
    /// # Returns
    ///
    /// A mutable reference to the parameter group at the given index, or None if out of bounds
    pub fn get_parameter_group_mut(&mut self, index: usize) -> Option<&mut ParameterGroup<A, D>> {
        self.parameter_groups.get_mut(index)
    }

    /// Get all current parameter values as a single array
    ///
    /// # Returns
    ///
    /// A result containing all parameter values concatenated into a single array
    pub fn get_all_parameters(&self) -> Result<Vec<Array<A, D>>> {
        Ok(self
            .parameter_groups
            .iter()
            .map(|group| group.params.clone())
            .collect())
    }

    /// Update all parameter groups using their assigned optimizers
    ///
    /// # Arguments
    ///
    /// * `gradients` - List of gradient arrays corresponding to parameter groups
    ///
    /// # Returns
    ///
    /// Result with the updated parameter values, or an error
    pub fn update_all_parameters(&mut self, gradients: &[Array<A, D>]) -> Result<Vec<Array<A, D>>> {
        // Check if the number of gradients matches the number of parameter groups
        if gradients.len() != self.parameter_groups.len() {
            return Err(OptimError::InvalidConfig(format!(
                "Number of gradients ({}) does not match number of parameter groups ({})",
                gradients.len(),
                self.parameter_groups.len()
            )));
        }

        let mut updated_params = Vec::with_capacity(self.parameter_groups.len());

        // Update each parameter group using its assigned optimizer
        for (i, group) in self.parameter_groups.iter_mut().enumerate() {
            let optimizerindex = group.optimizerindex;

            // Check if the optimizer index is valid
            if optimizerindex >= self.optimizers.len() {
                return Err(OptimError::InvalidConfig(format!(
                    "Invalid optimizer index: {}. Only {} optimizers available.",
                    optimizerindex,
                    self.optimizers.len()
                )));
            }

            // Get the optimizer and update the parameters
            let optimizer = &mut self.optimizers[optimizerindex];
            let params = &group.params;
            let gradient = &gradients[i];

            // Update the parameters
            let updated = optimizer.step(params, gradient)?;
            group.params = updated.clone();
            updated_params.push(updated);
        }

        Ok(updated_params)
    }
}

impl<A, D> Optimizer<A, D> for ParallelOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    fn step(&mut self, _params: &Array<A, D>, gradients: &Array<A, D>) -> Result<Array<A, D>> {
        // This implementation is a bit tricky since we have multiple parameter groups
        // We'll return an error message directing users to use update_all_parameters instead
        Err(OptimError::InvalidConfig(
            "ParallelOptimizer doesn't support the standard step method. Use update_all_parameters instead."
                .to_string(),
        ))
    }

    fn step_list(
        &mut self,
        params_list: &[&Array<A, D>],
        gradients_list: &[&Array<A, D>],
    ) -> Result<Vec<Array<A, D>>> {
        // Convert params_list to owned arrays
        let params_vec: Vec<Array<A, D>> = params_list.iter().map(|&p| p.clone()).collect();

        // Set parameter groups based on the input params
        self.parameter_groups = params_vec
            .into_iter()
            .enumerate()
            .map(|(i, params)| {
                // Use the first optimizer for all if there are more params than optimizers
                let optimizerindex = i.min(self.optimizers.len() - 1);
                ParameterGroup::new(params, optimizerindex)
            })
            .collect();

        // Convert gradients_list to owned arrays
        let gradients_vec: Vec<Array<A, D>> = gradients_list.iter().map(|&g| g.clone()).collect();

        // Update parameter groups using their assigned optimizers
        self.update_all_parameters(&gradients_vec)
    }

    fn get_learning_rate(&self) -> A {
        // Return the learning rate of the first optimizer, or a default if empty
        if let Some(optimizer) = self.optimizers.first() {
            optimizer.get_learning_rate()
        } else {
            A::from(0.01).expect("unwrap failed") // Default learning rate
        }
    }

    fn set_learning_rate(&mut self, learningrate: A) {
        // Set the learning _rate for all optimizers
        for optimizer in &mut self.optimizers {
            optimizer.set_learning_rate(learningrate);
        }
    }
}

/// A chained composition of optimizers
///
/// This wraps one optimizer with another, similar to how Lookahead wraps
/// another optimizer. The inner optimizer is applied first, and then the
/// outer optimizer is applied to the result.
///
/// # Example
///
/// ```
/// use scirs2_core::ndarray::Array1;
/// use optirs_core::optimizer_composition::ChainedOptimizer;
/// use optirs_core::optimizers::{SGD, Adam, Optimizer};
///
/// // Create optimizers
/// let inner = SGD::new(0.1);
/// let outer = Adam::new(0.01);
///
/// // Chain them together
/// let mut chained_optimizer = ChainedOptimizer::new(Box::new(inner), Box::new(outer));
///
/// // Use the chained optimizer
/// let params = Array1::zeros(5);
/// let gradients = Array1::ones(5);
/// let updated_params = chained_optimizer.step(&params, &gradients).expect("unwrap failed");
/// ```
pub struct ChainedOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    /// The inner optimizer, applied first
    inner: Box<dyn Optimizer<A, D>>,
    /// The outer optimizer, applied to the result of the inner optimizer
    outer: Box<dyn Optimizer<A, D>>,
}

impl<A, D> ChainedOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    /// Create a new chained optimizer
    ///
    /// # Arguments
    ///
    /// * `inner` - The inner optimizer, applied first
    /// * `outer` - The outer optimizer, applied to the result of the inner optimizer
    pub fn new(inner: Box<dyn Optimizer<A, D>>, outer: Box<dyn Optimizer<A, D>>) -> Self {
        Self { inner, outer }
    }

    /// Get a reference to the inner optimizer
    pub fn inner(&self) -> &dyn Optimizer<A, D> {
        self.inner.as_ref()
    }

    /// Get a mutable reference to the inner optimizer
    pub fn inner_mut(&mut self) -> &mut dyn Optimizer<A, D> {
        self.inner.as_mut()
    }

    /// Get a reference to the outer optimizer
    pub fn outer(&self) -> &dyn Optimizer<A, D> {
        self.outer.as_ref()
    }

    /// Get a mutable reference to the outer optimizer
    pub fn outer_mut(&mut self) -> &mut dyn Optimizer<A, D> {
        self.outer.as_mut()
    }
}

impl<A, D> Optimizer<A, D> for ChainedOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    fn step(&mut self, params: &Array<A, D>, gradients: &Array<A, D>) -> Result<Array<A, D>> {
        // Apply the inner optimizer first
        let intermediate_params = self.inner.step(params, gradients)?;

        // Then apply the outer optimizer to the result
        self.outer.step(&intermediate_params, gradients)
    }

    fn get_learning_rate(&self) -> A {
        // Return the learning rate of the inner optimizer
        self.inner.get_learning_rate()
    }

    fn set_learning_rate(&mut self, learningrate: A) {
        // Set the learning _rate for both optimizers
        self.inner.set_learning_rate(learningrate);
        self.outer.set_learning_rate(learningrate);
    }
}

/// A weighted composition of optimizers
///
/// Runs all optimizers on the same parameters/gradients and returns the
/// weighted average of their outputs. This allows blending the behavior
/// of multiple optimization strategies.
///
/// # Example
///
/// ```
/// use scirs2_core::ndarray::Array1;
/// use optirs_core::optimizer_composition::WeightedOptimizer;
/// use optirs_core::optimizers::{SGD, Adam, Optimizer};
///
/// // Create a weighted combination of SGD and Adam
/// let mut weighted = WeightedOptimizer::new()
///     .add_optimizer(Box::new(SGD::new(0.1)), 0.7)
///     .add_optimizer(Box::new(Adam::new(0.01)), 0.3);
///
/// let params = Array1::zeros(3);
/// let gradients = Array1::ones(3);
/// let updated = weighted.step(&params, &gradients).expect("step failed");
/// ```
pub struct WeightedOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    /// The optimizers and their associated weights
    optimizers: Vec<Box<dyn Optimizer<A, D>>>,
    /// The weight for each optimizer
    weights: Vec<A>,
}

impl<A, D> Default for WeightedOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    fn default() -> Self {
        Self::new()
    }
}

impl<A, D> WeightedOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    /// Create a new empty weighted optimizer
    pub fn new() -> Self {
        Self {
            optimizers: Vec::new(),
            weights: Vec::new(),
        }
    }

    /// Add an optimizer with a given weight (builder pattern)
    ///
    /// # Arguments
    ///
    /// * `opt` - The optimizer to add
    /// * `weight` - The weight for this optimizer
    pub fn add_optimizer(mut self, opt: Box<dyn Optimizer<A, D>>, weight: A) -> Self {
        self.optimizers.push(opt);
        self.weights.push(weight);
        self
    }

    /// Add multiple optimizers at once (builder pattern)
    ///
    /// # Arguments
    ///
    /// * `opts` - A vector of (optimizer, weight) pairs
    pub fn with_optimizers(mut self, opts: Vec<(Box<dyn Optimizer<A, D>>, A)>) -> Self {
        for (opt, weight) in opts {
            self.optimizers.push(opt);
            self.weights.push(weight);
        }
        self
    }

    /// Normalize weights so they sum to 1
    pub fn normalize_weights(&mut self) {
        let sum: A = self.weights.iter().copied().fold(A::zero(), |a, b| a + b);
        if sum > A::zero() {
            for w in &mut self.weights {
                *w = *w / sum;
            }
        }
    }

    /// Get the number of optimizers
    pub fn num_optimizers(&self) -> usize {
        self.optimizers.len()
    }

    /// Get the current weights
    pub fn weights(&self) -> &[A] {
        &self.weights
    }
}

impl<A, D> Optimizer<A, D> for WeightedOptimizer<A, D>
where
    A: Float + ScalarOperand + Debug,
    D: Dimension,
{
    fn step(&mut self, params: &Array<A, D>, gradients: &Array<A, D>) -> Result<Array<A, D>> {
        if self.optimizers.is_empty() {
            return Err(OptimError::InvalidConfig(
                "WeightedOptimizer has no optimizers".to_string(),
            ));
        }

        // Compute the weight sum for normalization
        let weight_sum: A = self.weights.iter().copied().fold(A::zero(), |a, b| a + b);
        if weight_sum <= A::zero() {
            return Err(OptimError::InvalidConfig(
                "WeightedOptimizer weight sum must be positive".to_string(),
            ));
        }

        // Run each optimizer and accumulate the weighted result
        let mut result: Option<Array<A, D>> = None;

        for (optimizer, &weight) in self.optimizers.iter_mut().zip(self.weights.iter()) {
            let updated = optimizer.step(params, gradients)?;
            let normalized_weight = weight / weight_sum;

            match result {
                None => {
                    result = Some(updated * normalized_weight);
                }
                Some(ref mut acc) => {
                    acc.zip_mut_with(&updated, |a, &b| {
                        *a = *a + b * normalized_weight;
                    });
                }
            }
        }

        result.ok_or_else(|| {
            OptimError::InvalidConfig("WeightedOptimizer produced no result".to_string())
        })
    }

    fn get_learning_rate(&self) -> A {
        if let Some(optimizer) = self.optimizers.first() {
            optimizer.get_learning_rate()
        } else {
            A::from(0.01).expect("failed to convert default learning rate")
        }
    }

    fn set_learning_rate(&mut self, learning_rate: A) {
        for optimizer in &mut self.optimizers {
            optimizer.set_learning_rate(learning_rate);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::optimizers::{Adam, SGD};
    use approx::assert_abs_diff_eq;
    use scirs2_core::ndarray::Array1;

    #[test]
    fn test_sequential_optimizer() {
        // Create a sequential optimizer with SGD followed by Adam
        let sgd = SGD::new(0.1);
        let adam = Adam::new(0.01);

        let mut seq_optimizer: SequentialOptimizer<f64, scirs2_core::ndarray::Ix1> =
            SequentialOptimizer::new(vec![Box::new(sgd), Box::new(adam)]);

        // Create test parameters and gradients
        let params = Array1::zeros(3);
        let gradients = Array1::from_vec(vec![1.0, 2.0, 3.0]);

        // Apply the sequential optimizer
        let updated_params = seq_optimizer
            .step(&params, &gradients)
            .expect("unwrap failed");

        // Verify the result
        // First SGD updates: params - 0.1 * gradients = [0, 0, 0] - 0.1 * [1, 2, 3] = [-0.1, -0.2, -0.3]
        // Then Adam makes additional updates
        assert!(updated_params[0] < -0.1);
        assert!(updated_params[1] < -0.2);
        assert!(updated_params[2] < -0.3);
    }

    #[test]
    fn test_parallel_optimizer() {
        // Create a parallel optimizer with SGD and Adam
        let sgd = SGD::new(0.1);
        let adam = Adam::new(0.01);

        let params1 = Array1::zeros(2);
        let params2 = Array1::zeros(3);

        let group1 = ParameterGroup::new(params1.clone(), 0); // Use SGD
        let group2 = ParameterGroup::new(params2.clone(), 1); // Use Adam

        let mut parallel_optimizer: ParallelOptimizer<f64, scirs2_core::ndarray::Ix1> =
            ParallelOptimizer::new(vec![Box::new(sgd), Box::new(adam)], vec![group1, group2]);

        // Create test gradients
        let gradients1 = Array1::from_vec(vec![1.0, 2.0]);
        let gradients2 = Array1::from_vec(vec![3.0, 4.0, 5.0]);

        // Update the parameters
        let updated_params = parallel_optimizer
            .update_all_parameters(&[gradients1, gradients2])
            .expect("unwrap failed");

        // Verify the results
        // Group 1 (SGD): params - 0.1 * gradients = [0, 0] - 0.1 * [1, 2] = [-0.1, -0.2]
        assert_abs_diff_eq!(updated_params[0][0], -0.1);
        assert_abs_diff_eq!(updated_params[0][1], -0.2);

        // Group 2 (Adam): The update will be different due to Adam's adaptive nature
        // Just verify it's different from the original params
        assert!(updated_params[1][0] != 0.0);
        assert!(updated_params[1][1] != 0.0);
        assert!(updated_params[1][2] != 0.0);
    }

    #[test]
    fn test_chained_optimizer() {
        // Create a chained optimizer with SGD as inner and Adam as outer
        let inner = SGD::new(0.1);
        let outer = Adam::new(0.01);

        let mut chained_optimizer: ChainedOptimizer<f64, scirs2_core::ndarray::Ix1> =
            ChainedOptimizer::new(Box::new(inner), Box::new(outer));

        // Create test parameters and gradients
        let params = Array1::zeros(3);
        let gradients = Array1::from_vec(vec![1.0, 2.0, 3.0]);

        // Apply the chained optimizer
        let updated_params = chained_optimizer
            .step(&params, &gradients)
            .expect("unwrap failed");

        // Verify the result
        // Inner (SGD): params - 0.1 * gradients = [0, 0, 0] - 0.1 * [1, 2, 3] = [-0.1, -0.2, -0.3]
        // Then outer (Adam) applies another update
        assert!(updated_params[0] < -0.1);
        assert!(updated_params[1] < -0.2);
        assert!(updated_params[2] < -0.3);
    }

    #[test]
    fn test_sequential_learning_rate() {
        // Create a sequential optimizer with SGD followed by Adam
        let sgd = SGD::new(0.1);
        let adam = Adam::new(0.01);

        let mut seq_optimizer: SequentialOptimizer<f64, scirs2_core::ndarray::Ix1> =
            SequentialOptimizer::new(vec![Box::new(sgd), Box::new(adam)]);

        // Test getting the learning rate (should be from the first optimizer)
        assert_abs_diff_eq!(seq_optimizer.get_learning_rate(), 0.1);

        // Test setting the learning rate for all optimizers
        seq_optimizer.set_learning_rate(0.05);

        // Verify the learning rate has been set for both optimizers
        assert_abs_diff_eq!(seq_optimizer.get_learning_rate(), 0.05);
        assert_abs_diff_eq!(
            seq_optimizer
                .get_optimizer(0)
                .expect("unwrap failed")
                .get_learning_rate(),
            0.05
        );
        assert_abs_diff_eq!(
            seq_optimizer
                .get_optimizer(1)
                .expect("unwrap failed")
                .get_learning_rate(),
            0.05
        );
    }

    #[test]
    fn test_parallel_optimizer_step_list() {
        // Create a parallel optimizer with SGD and Adam
        let sgd = SGD::new(0.1);
        let adam = Adam::new(0.01);

        let mut parallel_optimizer: ParallelOptimizer<f64, scirs2_core::ndarray::Ix1> =
            ParallelOptimizer::new(vec![Box::new(sgd), Box::new(adam)], vec![]);

        // Create test parameters and gradients
        let params1 = Array1::zeros(2);
        let params2 = Array1::zeros(3);
        let params3 = Array1::zeros(4);

        let gradients1 = Array1::from_vec(vec![1.0, 2.0]);
        let gradients2 = Array1::from_vec(vec![3.0, 4.0, 5.0]);
        let gradients3 = Array1::from_vec(vec![6.0, 7.0, 8.0, 9.0]);

        // Use step_list to update all parameters
        let params_refs = vec![&params1, &params2, &params3];
        let gradients_refs = vec![&gradients1, &gradients2, &gradients3];

        let updated_params = parallel_optimizer
            .step_list(&params_refs, &gradients_refs)
            .expect("unwrap failed");

        // Verify the results
        // Group 1 (SGD): params - 0.1 * gradients = [0, 0] - 0.1 * [1, 2] = [-0.1, -0.2]
        assert_abs_diff_eq!(updated_params[0][0], -0.1);
        assert_abs_diff_eq!(updated_params[0][1], -0.2);

        // Group 2 will use SGD since we only have 2 optimizers and index 1 % 2 = 1 (Adam)
        // Adam: The update will be different than SGD
        assert!(updated_params[1][0] != -0.3);

        // Group 3 will wrap around to optimize with Adam
        // Just check that it's been updated from zero
        assert!(updated_params[2][0] < 0.0);
    }

    #[test]
    fn test_chained_optimizer_learning_rate() {
        // Create a chained optimizer with SGD as inner and Adam as outer
        let inner = SGD::new(0.1);
        let outer = Adam::new(0.01);

        let mut chained_optimizer: ChainedOptimizer<f64, scirs2_core::ndarray::Ix1> =
            ChainedOptimizer::new(Box::new(inner), Box::new(outer));

        // Test getting the learning rate (should be from the inner optimizer)
        assert_abs_diff_eq!(chained_optimizer.get_learning_rate(), 0.1);

        // Test setting the learning rate for both optimizers
        chained_optimizer.set_learning_rate(0.05);

        // Verify the learning rate has been set for both optimizers
        assert_abs_diff_eq!(chained_optimizer.get_learning_rate(), 0.05);
        assert_abs_diff_eq!(chained_optimizer.inner().get_learning_rate(), 0.05);
        assert_abs_diff_eq!(chained_optimizer.outer().get_learning_rate(), 0.05);
    }

    #[test]
    fn test_weighted_optimizer_basic() {
        // Create two SGD optimizers with different learning rates
        let sgd1 = SGD::new(0.1);
        let sgd2 = SGD::new(0.2);

        let mut weighted: WeightedOptimizer<f64, scirs2_core::ndarray::Ix1> =
            WeightedOptimizer::new()
                .add_optimizer(Box::new(sgd1), 0.5)
                .add_optimizer(Box::new(sgd2), 0.5);

        let params = Array1::zeros(3);
        let gradients = Array1::ones(3);

        let updated = weighted.step(&params, &gradients).expect("step failed");

        // SGD1: params - 0.1 * grads = [-0.1, -0.1, -0.1]
        // SGD2: params - 0.2 * grads = [-0.2, -0.2, -0.2]
        // Weighted avg (0.5 each): 0.5*(-0.1) + 0.5*(-0.2) = -0.15
        assert_abs_diff_eq!(updated[0], -0.15, epsilon = 1e-10);
        assert_abs_diff_eq!(updated[1], -0.15, epsilon = 1e-10);
        assert_abs_diff_eq!(updated[2], -0.15, epsilon = 1e-10);
    }

    #[test]
    fn test_weighted_optimizer_unequal_weights() {
        let sgd1 = SGD::new(0.1);
        let sgd2 = SGD::new(0.2);

        let mut weighted: WeightedOptimizer<f64, scirs2_core::ndarray::Ix1> =
            WeightedOptimizer::new()
                .add_optimizer(Box::new(sgd1), 3.0)
                .add_optimizer(Box::new(sgd2), 1.0);

        let params = Array1::zeros(2);
        let gradients = Array1::ones(2);

        let updated = weighted.step(&params, &gradients).expect("step failed");

        // SGD1: [-0.1, -0.1], SGD2: [-0.2, -0.2]
        // Weights normalized: 3/4=0.75, 1/4=0.25
        // Result: 0.75*(-0.1) + 0.25*(-0.2) = -0.075 - 0.05 = -0.125
        assert_abs_diff_eq!(updated[0], -0.125, epsilon = 1e-10);
    }

    #[test]
    fn test_weighted_optimizer_empty() {
        let mut weighted: WeightedOptimizer<f64, scirs2_core::ndarray::Ix1> =
            WeightedOptimizer::new();

        let params = Array1::zeros(3);
        let gradients = Array1::ones(3);

        let result = weighted.step(&params, &gradients);
        assert!(result.is_err());
    }

    #[test]
    fn test_weighted_optimizer_normalize_weights() {
        let mut weighted: WeightedOptimizer<f64, scirs2_core::ndarray::Ix1> =
            WeightedOptimizer::new()
                .add_optimizer(Box::new(SGD::new(0.1)), 2.0)
                .add_optimizer(Box::new(SGD::new(0.2)), 8.0);

        weighted.normalize_weights();

        assert_abs_diff_eq!(weighted.weights()[0], 0.2, epsilon = 1e-10);
        assert_abs_diff_eq!(weighted.weights()[1], 0.8, epsilon = 1e-10);
    }

    #[test]
    fn test_weighted_optimizer_learning_rate() {
        let mut weighted: WeightedOptimizer<f64, scirs2_core::ndarray::Ix1> =
            WeightedOptimizer::new()
                .add_optimizer(Box::new(SGD::new(0.1)), 1.0)
                .add_optimizer(Box::new(Adam::new(0.01)), 1.0);

        // Learning rate comes from the first optimizer
        assert_abs_diff_eq!(weighted.get_learning_rate(), 0.1);

        // Setting learning rate applies to all
        weighted.set_learning_rate(0.05);
        assert_abs_diff_eq!(weighted.get_learning_rate(), 0.05);
    }

    #[test]
    fn test_weighted_optimizer_with_optimizers() {
        let opts: Vec<(Box<dyn Optimizer<f64, scirs2_core::ndarray::Ix1>>, f64)> = vec![
            (Box::new(SGD::new(0.1)), 1.0),
            (Box::new(SGD::new(0.2)), 1.0),
        ];

        let weighted: WeightedOptimizer<f64, scirs2_core::ndarray::Ix1> =
            WeightedOptimizer::new().with_optimizers(opts);

        assert_eq!(weighted.num_optimizers(), 2);
        assert_abs_diff_eq!(weighted.weights()[0], 1.0);
        assert_abs_diff_eq!(weighted.weights()[1], 1.0);
    }
}