Make LogRange deprecated

Author: 38

examples/two-scales.rs

@@ -11,7 +11,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         .right_y_label_area_size(40)
         .margin(5)
         .caption("Dual Y-Axis Example", ("sans-serif", 50.0).into_font())
-        .build_cartesian_2d(0f32..10f32, LogRange(0.1f32..1e10f32))?
+        .build_cartesian_2d(0f32..10f32, (0.1f32..1e10f32).log_scale())?
         .set_secondary_coord(0f32..10f32, -1.0f32..1.0f32);
 
     chart

src/coord/ranged1d/combinators/logarithmic.rs

@@ -4,7 +4,7 @@ use std::marker::PhantomData;
 use std::ops::Range;
 
 /// The trait for the type that is able to be presented in the log scale.
-/// This trait is primarily used by [LogRange](struct.LogRange.html).
+/// This trait is primarily used by [LogRangeExt](struct.LogRangeExt.html).
 pub trait LogScalable: Clone {
     /// Make the conversion from the type to the floating point number
     fn as_f64(&self) -> f64;
@@ -47,11 +47,20 @@ impl_log_scalable!(i, u16);
 impl_log_scalable!(i, u32);
 impl_log_scalable!(i, u64);
 
+impl_log_scalable!(i, i8);
+impl_log_scalable!(i, i16);
+impl_log_scalable!(i, i32);
+impl_log_scalable!(i, i64);
+
 impl_log_scalable!(f, f32);
 impl_log_scalable!(f, f64);
 
+/// Convert a range to a log scale coordinate spec
 pub trait IntoLogRange {
+    /// The type of the value
     type ValueType: LogScalable;
+
+    /// Make the log scale coordinate
     fn log_scale(self) -> LogRangeExt<Self::ValueType>;
 }
 
@@ -68,9 +77,6 @@ impl<T: LogScalable> IntoLogRange for Range<T> {
 
 /// The logarithmic coodinate decorator.
 /// This decorator is used to make the axis rendered as logarithmically.
-#[derive(Clone)]
-pub struct LogRange<V: LogScalable>(pub Range<V>);
-
 #[derive(Clone)]
 pub struct LogRangeExt<V: LogScalable> {
     range: Range<V>,
@@ -79,6 +85,8 @@ pub struct LogRangeExt<V: LogScalable> {
 }
 
 impl<V: LogScalable> LogRangeExt<V> {
+    /// Set the zero point of the log scale coordinate. Zero point is the point where we map -inf
+    /// of the axis to the coordinate
     pub fn zero_point(mut self, value: V) -> Self
     where
         V: PartialEq,
@@ -92,6 +100,7 @@ impl<V: LogScalable> LogRangeExt<V> {
         self
     }
 
+    /// Set the base multipler
     pub fn base(mut self, base: f64) -> Self {
         if self.base > 1.0 {
             self.base = base;
@@ -100,12 +109,6 @@ impl<V: LogScalable> LogRangeExt<V> {
     }
 }
 
-impl<V: LogScalable> From<LogRange<V>> for LogCoord<V> {
-    fn from(range: LogRange<V>) -> LogCoord<V> {
-        range.0.log_scale().into()
-    }
-}
-
 impl<V: LogScalable> From<LogRangeExt<V>> for LogCoord<V> {
     fn from(spec: LogRangeExt<V>) -> LogCoord<V> {
         let zero_point = spec.zero;
@@ -140,11 +143,6 @@ impl<V: LogScalable> From<LogRangeExt<V>> for LogCoord<V> {
     }
 }
 
-impl<V: LogScalable> AsRangedCoord for LogRange<V> {
-    type CoordDescType = LogCoord<V>;
-    type Value = V;
-}
-
 impl<V: LogScalable> AsRangedCoord for LogRangeExt<V> {
     type CoordDescType = LogCoord<V>;
     type Value = V;
@@ -201,8 +199,6 @@ impl<V: LogScalable> Ranged for LogCoord<V> {
         let base = self.base;
         let base_ln = base.ln();
 
-        /*let mut start = self.//self.value_to_f64(&self.logic.start);
-        let mut end = self.value_to_f64(&self.logic.end);*/
         let Range { mut start, mut end } = self.normalized;
 
         if start > end {
@@ -257,6 +253,26 @@ impl<V: LogScalable> Ranged for LogCoord<V> {
         self.logic.clone()
     }
 }
+
+/// The logarithmic coodinate decorator.
+/// This decorator is used to make the axis rendered as logarithmically.
+#[deprecated(note = "LogRange is deprecated, use IntoLogRange trait method instead")]
+#[derive(Clone)]
+pub struct LogRange<V: LogScalable>(pub Range<V>);
+
+#[allow(deprecated)]
+impl<V: LogScalable> AsRangedCoord for LogRange<V> {
+    type CoordDescType = LogCoord<V>;
+    type Value = V;
+}
+
+#[allow(deprecated)]
+impl<V: LogScalable> From<LogRange<V>> for LogCoord<V> {
+    fn from(range: LogRange<V>) -> LogCoord<V> {
+        range.0.log_scale().into()
+    }
+}
+
 #[cfg(test)]
 mod test {
     use super::*;

src/coord/ranged1d/combinators/mod.rs

@@ -8,7 +8,10 @@ mod linspace;
 pub use linspace::{IntoLinspace, Linspace};
 
 mod logarithmic;
-pub use logarithmic::{IntoLogRange, LogCoord, LogRange, LogScalable};
+pub use logarithmic::{IntoLogRange, LogCoord, LogScalable};
+
+#[allow(deprecated)]
+pub use logarithmic::LogRange;
 
 mod nested;
 pub use nested::{BuildNestedCoord, NestedRange, NestedValue};

src/lib.rs

@@ -751,13 +751,16 @@ pub mod prelude {
         cartesian::Cartesian2d,
         combinators::{
             make_partial_axis, BindKeyPointMethod, BindKeyPoints, BuildNestedCoord, GroupBy,
-            IntoLinspace, IntoLogRange, IntoPartialAxis, Linspace, LogCoord, LogRange, LogScalable,
+            IntoLinspace, IntoLogRange, IntoPartialAxis, Linspace, LogCoord, LogScalable,
             NestedRange, NestedValue, ToGroupByRange,
         },
         ranged1d::{DiscreteRanged, IntoSegmentedCoord, Ranged, SegmentValue},
         CoordTranslate,
     };
 
+    #[allow(deprecated)]
+    pub use crate::coord::combinators::LogRange;
+
     #[cfg(feature = "chrono")]
     pub use crate::coord::types::{
         IntoMonthly, IntoYearly, RangedDate, RangedDateTime, RangedDuration,