multi-series API

Author: kojix2

spec/reference_spec.cr

@@ -251,10 +251,13 @@ describe "Julia reference output compatibility" do
     end
 
     it "matches lineplot/color_vector" do
-      p = UnicodePlot.lineplot([Float64::NAN], [Float64::NAN], xlim: {-1.0, 7.0}, ylim: {-1.0, 9.0})
-      UnicodePlot.lineplot!(p, [-1.0, 2.0], [-1.0, 2.0], color: :red)
-      UnicodePlot.lineplot!(p, [2.0, 3.0], [2.0, 9.0], color: :green)
-      UnicodePlot.lineplot!(p, [3.0, 7.0], [9.0, 4.0], color: :blue)
+      p = UnicodePlot.lineplot(
+        [[-1.0, 2.0], [2.0, 3.0], [3.0, 7.0]],
+        [[-1.0, 2.0], [2.0, 9.0], [9.0, 4.0]],
+        color: [:red, :green, :blue],
+        xlim: {-1.0, 7.0},
+        ylim: {-1.0, 9.0},
+      )
       test_ref("lineplot/color_vector.txt", p)
     end
 

spec/unicode_plot_spec.cr

@@ -60,6 +60,25 @@ describe UnicodePlot do
       p.to_s.should be_a(String)
     end
 
+    it "accepts multi-series input with per-series colors" do
+      p = UnicodePlot.lineplot(
+        [[-1.0, 2.0], [2.0, 3.0], [3.0, 7.0]],
+        [[-1.0, 2.0], [2.0, 9.0], [9.0, 4.0]],
+        color: [:red, :green, :blue]
+      )
+      p.series.should eq(3)
+    end
+
+    it "raises when color vector length does not match series count" do
+      expect_raises(ArgumentError, /color vector must have the same length as the number of series/) do
+        UnicodePlot.lineplot(
+          [[1.0, 2.0], [3.0, 4.0]],
+          [[1.0, 2.0], [3.0, 4.0]],
+          color: [:red]
+        )
+      end
+    end
+
     it "accepts Int64 arrays via numeric overload" do
       p = UnicodePlot.lineplot([1_i64, 2_i64, 3_i64], [1_i64, 4_i64, 9_i64])
       p.to_s.should be_a(String)
@@ -140,6 +159,15 @@ describe UnicodePlot do
       p.to_s.should be_a(String)
     end
 
+    it "accepts multi-series input with per-series colors" do
+      p = UnicodePlot.scatterplot(
+        [[1.0, 2.0], [2.0, 3.0]],
+        [[1.0, 4.0], [4.0, 9.0]],
+        color: [:red, :green]
+      )
+      p.series.should eq(2)
+    end
+
     it "accepts y-only numeric overload" do
       p = UnicodePlot.scatterplot([1_i16, 4_i16, 9_i16])
       p.to_s.should be_a(String)

src/unicode_plot/common.cr

@@ -6,6 +6,8 @@ module UnicodePlot
   HALF_BLOCK    = '▄'
 
   alias ColorType = UInt32
+  alias PlotColor = Symbol | UInt32 | {Int32, Int32, Int32}
+  alias PlotColorArg = PlotColor | Array(Symbol) | Array(UInt32) | Array({Int32, Int32, Int32})
   INVALID_COLOR = UInt32::MAX
   THRESHOLD     = 256_u32 ** 3 # 16_777_216 — 8bit/24bit threshold
 

src/unicode_plot/interface/lineplot.cr

@@ -5,7 +5,7 @@ module UnicodePlot
     *,
     canvas : Symbol = :braille,
     name : String = "",
-    color : Symbol | UInt32 | {Int32, Int32, Int32} = :auto,
+    color : PlotColor = :auto,
     head_tail : Symbol? = nil,
     head_tail_frac : Float64 = 0.05,
     title : String = "",
@@ -35,8 +35,90 @@ module UnicodePlot
     thousands_separator : Char = ' ',
   ) : Plot
     raise ArgumentError.new("x and y must have the same length") unless x.size == y.size
+    lineplot(
+      [x], [y],
+      canvas: canvas,
+      name: name,
+      color: color,
+      head_tail: head_tail,
+      head_tail_frac: head_tail_frac,
+      title: title,
+      xlabel: xlabel,
+      ylabel: ylabel,
+      xscale: xscale,
+      yscale: yscale,
+      height: height,
+      width: width,
+      border: border,
+      compact_labels: compact_labels,
+      compact: compact,
+      blend: blend,
+      xlim: xlim,
+      ylim: ylim,
+      margin: margin,
+      padding: padding,
+      labels: labels,
+      grid: grid,
+      yticks: yticks,
+      xticks: xticks,
+      min_height: min_height,
+      min_width: min_width,
+      yflip: yflip,
+      xflip: xflip,
+      unicode_exponent: unicode_exponent,
+      thousands_separator: thousands_separator,
+    )
+  end
+
+  def lineplot(
+    x : Array(Array(Float64)),
+    y : Array(Array(Float64)),
+    *,
+    canvas : Symbol = :braille,
+    name : String = "",
+    color : PlotColorArg = :auto,
+    head_tail : Symbol? = nil,
+    head_tail_frac : Float64 = 0.05,
+    title : String = "",
+    xlabel : String = "",
+    ylabel : String = "",
+    xscale : Symbol | Proc(Float64, Float64) = :identity,
+    yscale : Symbol | Proc(Float64, Float64) = :identity,
+    height : Int32? = nil,
+    width : Int32? = nil,
+    border : Symbol = :solid,
+    compact_labels : Bool = false,
+    compact : Bool = false,
+    blend : Bool = true,
+    xlim : {Float64, Float64} = {0.0, 0.0},
+    ylim : {Float64, Float64} = {0.0, 0.0},
+    margin : Int32 = 3,
+    padding : Int32 = 1,
+    labels : Bool = true,
+    grid : Bool = true,
+    yticks : Bool = true,
+    xticks : Bool = true,
+    min_height : Int32 = 2,
+    min_width : Int32 = 5,
+    yflip : Bool = false,
+    xflip : Bool = false,
+    unicode_exponent : Bool = true,
+    thousands_separator : Char = ' ',
+  ) : Plot
+    raise ArgumentError.new("x and y must have the same number of series") unless x.size == y.size
+    if color.is_a?(Array)
+      raise ArgumentError.new("color vector must have the same length as the number of series") unless color.size == x.size
+    end
+
+    x.each_with_index do |x_values, i|
+      yv = y[i]
+      raise ArgumentError.new("x and y series must have the same length") unless x_values.size == yv.size
+    end
+
+    flat_x = x.flatten
+    flat_y = y.flatten
     plot = build_plot(
-      x, y,
+      flat_x, flat_y,
       canvas_type: canvas,
       title: title, xlabel: xlabel, ylabel: ylabel,
       xscale: xscale, yscale: yscale,
@@ -89,18 +171,61 @@ module UnicodePlot
     lineplot(to_plot_f64(x), to_plot_f64(y), **kwargs)
   end
 
-  # ameba:disable Metrics/CyclomaticComplexity
+  def lineplot(x : Array(Array(T)), y : Array(Array(U)), **kwargs) : Plot forall T, U
+    xs = x.map { |vals| to_plot_f64(vals) }
+    ys = y.map { |vals| to_plot_f64(vals) }
+    lineplot(xs, ys, **kwargs)
+  end
+
   def lineplot!(
     plot : Plot,
     x : Array(Float64),
     y : Array(Float64),
     *,
     name : String = "",
-    color : Symbol | UInt32 | {Int32, Int32, Int32} = :auto,
+    color : PlotColor = :auto,
     head_tail : Symbol? = nil,
     head_tail_frac : Float64 = 0.05,
   ) : Plot
     raise ArgumentError.new("x and y must have the same length") unless x.size == y.size
+    lineplot!(plot, [x], [y], name: name, color: color, head_tail: head_tail, head_tail_frac: head_tail_frac)
+  end
+
+  def lineplot!(
+    plot : Plot,
+    x : Array(Array(Float64)),
+    y : Array(Array(Float64)),
+    *,
+    name : String = "",
+    color : PlotColorArg = :auto,
+    head_tail : Symbol? = nil,
+    head_tail_frac : Float64 = 0.05,
+  ) : Plot
+    raise ArgumentError.new("x and y must have the same number of series") unless x.size == y.size
+    if color.is_a?(Array)
+      raise ArgumentError.new("color vector must have the same length as the number of series") unless color.size == x.size
+    end
+
+    x.each_with_index do |x_values, i|
+      yv = y[i]
+      raise ArgumentError.new("x and y series must have the same length") unless x_values.size == yv.size
+
+      series_color = color.is_a?(Array) ? color[i] : color
+      lineplot_single!(plot, x_values, yv, name: name, color: series_color, head_tail: head_tail, head_tail_frac: head_tail_frac)
+    end
+    plot
+  end
+
+  private def lineplot_single!(
+    plot : Plot,
+    x : Array(Float64),
+    y : Array(Float64),
+    *,
+    name : String = "",
+    color : PlotColor = :auto,
+    head_tail : Symbol? = nil,
+    head_tail_frac : Float64 = 0.05,
+  ) : Plot
     c = color == :auto ? plot.next_color! : color
     col = plot_color(c)
     plot.label!(:r, name, col) unless name.empty?
@@ -137,6 +262,12 @@ module UnicodePlot
     lineplot!(plot, to_plot_f64(x), to_plot_f64(y), **kwargs)
   end
 
+  def lineplot!(plot : Plot, x : Array(Array(T)), y : Array(Array(U)), **kwargs) : Plot forall T, U
+    xs = x.map { |vals| to_plot_f64(vals) }
+    ys = y.map { |vals| to_plot_f64(vals) }
+    lineplot!(plot, xs, ys, **kwargs)
+  end
+
   def lineplot!(plot : Plot, y : Array(T), **kwargs) : Plot forall T
     x = (1..y.size).map(&.to_f64)
     lineplot!(plot, x, to_plot_f64(y), **kwargs)