Refine serialization

justinlovinger · Sep 24, 2023 · a0bafc5 · a0bafc5
1 parent e5956e7
commit a0bafc5
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 0 deletions.
diff --git a/optimal-pbil/src/lib.rs b/optimal-pbil/src/lib.rs
@@ -78,6 +78,7 @@ pub struct Config {
 /// PBIL state.
 #[derive(Clone, Debug, PartialEq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", serde(transparent))]
 pub struct State<B>(DynState<B>);
 
 /// PBIL state kind.

diff --git a/optimal-pbil/src/types.rs b/optimal-pbil/src/types.rs
@@ -235,6 +235,8 @@ impl Ord for Probability {
 /// or below the inverse.
 #[derive(Clone, Copy, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", serde(into = "Probability"))]
+#[cfg_attr(feature = "serde", serde(try_from = "Probability"))]
 pub struct ProbabilityThreshold {
     ub: Probability,
     lb: Probability,

diff --git a/optimal-steepest/src/backtracking_steepest/mod.rs b/optimal-steepest/src/backtracking_steepest/mod.rs
@@ -92,6 +92,7 @@ pub struct Config<A> {
 /// Backtracking steepest descent state.
 #[derive(Clone, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", serde(transparent))]
 pub struct State<A>(DynState<A>);
 
 /// Backtracking steepest descent state kind.

diff --git a/optimal-steepest/src/backtracking_steepest/types.rs b/optimal-steepest/src/backtracking_steepest/types.rs
@@ -18,10 +18,18 @@ pub use optimal_core::prelude::*;
 #[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 
+// `#[serde(into = "A")]` and `#[serde(try_from = "A")]` makes more sense
+// than `#[serde(transparent)]`,
+// but as of 2023-09-24,
+// but we cannot `impl<A> From<Foo<A>> for A`
+// and manually implementing `Serialize` and `Deserialize`
+// is not worth the effort.
+
 /// The sufficient decrease parameter,
 /// `c_1`.
 #[derive(Clone, Copy, Debug, Display, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", serde(transparent))]
 pub struct SufficientDecreaseParameter<A>(A);
 
 derive_new_from_bounded_partial_ord!(SufficientDecreaseParameter<A: Real>);
@@ -58,6 +66,7 @@ where
 /// Rate to decrease step size while line searching.
 #[derive(Clone, Copy, Debug, Display, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", serde(transparent))]
 pub struct BacktrackingRate<A>(A);
 
 derive_new_from_bounded_partial_ord!(BacktrackingRate<A: Real>);
@@ -94,6 +103,7 @@ where
 /// Rate to increase step size before starting each line search.
 #[derive(Clone, Copy, Debug, Display, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", serde(transparent))]
 pub struct IncrRate<A>(A);
 
 derive_new_from_lower_bounded_partial_ord!(IncrRate<A: Real>);

diff --git a/optimal-steepest/src/fixed_step_steepest/mod.rs b/optimal-steepest/src/fixed_step_steepest/mod.rs
@@ -65,6 +65,7 @@ pub struct Config<A> {
 /// Fixed-step-size steepest descent state.
 #[derive(Clone, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", serde(transparent))]
 pub struct State<A>(DynState<A>);
 
 /// Fixed-step-size steepest descent state kind.