Merge pull request #25 from BigThinkcode/spline_curve

Spline curve

Author: Sadique-The-Alchemist

lib/matplotex.ex

@@ -2,6 +2,7 @@ defmodule Matplotex do
   @moduledoc """
   Module to generate a graph.
   """
+  alias Matplotex.Figure.Areal.Spline
   alias Matplotex.Figure.Areal.Histogram
   alias Matplotex.InputError
   alias Matplotex.Figure.Radial.Pie
@@ -33,6 +34,9 @@ defmodule Matplotex do
     |> BarChart.create({pos, values, width}, opts)
   end
 
+  @doc """
+  Creates a scatter plot based on the given data
+  """
   def scatter(stream, opts) when is_struct(stream, Stream) do
     Scatter.create(stream, opts)
   end
@@ -51,6 +55,9 @@ defmodule Matplotex do
     |> Scatter.create({x, y}, opts)
   end
 
+  @doc """
+  Creates a piec charts based on the size and opts
+  """
   def pie(sizes, opts \\ []) do
     Pie.create(%Figure{axes: %Pie{}}, sizes, opts)
   end
@@ -84,10 +91,26 @@ defmodule Matplotex do
     |> LinePlot.create({x, y}, opts)
   end
 
+  @doc """
+   Creates a histogram with given data and bins.
+
+   ## Examples
+
+       iex> Matplotex.hist([1, 2, 3, 4, 5, 6, 7, 8, 9, 10], 5)
+  """
+  def hist(data, bins), do: hist(data, bins, [])
+
   def hist(data, bins, opts) do
     Histogram.create(%Figure{axes: %Histogram{}}, {data, bins}, opts)
   end
 
+  def spline(x, y), do: spline(x, y, [])
+  def spline(x, y, opts), do: spline(%Figure{axes: %Spline{}}, x, y, opts)
+
+  def spline(%Figure{} = figure, x, y, opts) do
+    Spline.create(figure, {x, y}, opts)
+  end
+
   @doc """
   Sets X and Y labels for the graph with given font details
 

lib/matplotex/element.ex

@@ -1,8 +1,11 @@
 defmodule Matplotex.Element do
   @callback assemble(element :: struct()) :: String.t()
-  @callback flipy(element :: struct(), height :: number()) :: struct()
   def assemble(%module{} = element), do: module.assemble(element)
 
+  def to_pixel({x, y}) do
+    "#{to_pixel(x)},#{to_pixel(y)}"
+  end
+
   def to_pixel(inch) when is_number(inch), do: inch * 96
   def to_pixel(_), do: 0
 

lib/matplotex/element/circle.ex

@@ -32,8 +32,4 @@ defmodule Matplotex.Element.Circle do
   def get_cx(%{cx: x}), do: to_pixel(x)
   def get_cy(%{cy: y}), do: to_pixel(y)
   def get_r(%{r: r}), do: to_pixel(r)
-  @impl Element
-  def flipy(%__MODULE__{cy: y} = circle, height) do
-    %__MODULE__{circle | cy: height - y}
-  end
 end

lib/matplotex/element/label.ex

@@ -71,8 +71,4 @@ defmodule Matplotex.Element.Label do
   def get_y(%{y: y}), do: to_pixel(y)
   def get_width(%{width: width}), do: to_pixel(width)
   def get_height(%{height: height}), do: to_pixel(height)
-  @impl Element
-  def flipy(%__MODULE__{y: y} = label, height) do
-    %__MODULE__{label | y: height - y}
-  end
 end

lib/matplotex/element/legend.ex

@@ -30,11 +30,6 @@ defmodule Matplotex.Element.Legend do
     """
   end
 
-  @impl Element
-  def flipy(%__MODULE__{y: y} = legend, height) do
-    %__MODULE__{legend | y: height - y, label: Label.flipy(legend.label, height)}
-  end
-
   defp handle(%__MODULE__{handle: %handle_element{} = handle}) do
     handle_element.assemble(handle)
   end

lib/matplotex/element/line.ex

@@ -52,10 +52,6 @@ defmodule Matplotex.Element.Line do
   def get_x2(%{x2: x2}), do: to_pixel(x2)
   def get_y1(%{y1: y1}), do: to_pixel(y1)
   def get_y2(%{y2: y2}), do: to_pixel(y2)
-  @impl Element
-  def flipy(%__MODULE__{y1: y1, y2: y2} = line, height) do
-    %__MODULE__{line | y1: height - y1, y2: height - y2}
-  end
 
   defp stroke_dasharray(%{linestyle: "_"}), do: nil
 

lib/matplotex/element/polygon.ex

@@ -15,18 +15,6 @@ defmodule Matplotex.Element.Polygon do
     )
   end
 
-  @impl Element
-  def flipy(%__MODULE__{points: point} = label, height) do
-    %__MODULE__{label | points: flip_point(point, height)}
-  end
-
-  defp flip_point(point, height) do
-    Enum.map(point, &flip_coord(&1, height))
-  end
-
-  defp flip_coord({x, y}, height) do
-    {x, height - y}
-  end
 
   defp assemble_point(%{points: point}) do
     for {x, y} <- point do

lib/matplotex/element/rad_legend.ex

@@ -30,11 +30,6 @@ defmodule Matplotex.Element.RadLegend do
     """
   end
 
-  @impl Element
-  def flipy(%__MODULE__{y: y} = legend, height) do
-    %__MODULE__{legend | y: height - y, label: Label.flipy(legend.label, height)}
-  end
-
   def with_label(
         %__MODULE__{
           label: text,

lib/matplotex/element/rect.ex

@@ -50,8 +50,4 @@ defmodule Matplotex.Element.Rect do
   def get_y(%{y: y}), do: to_pixel(y)
   def get_width(%{width: width}), do: to_pixel(width)
   def get_height(%{height: height}), do: to_pixel(height)
-  @impl Element
-  def flipy(%__MODULE__{y: y} = rect, height) do
-    %__MODULE__{rect | y: height - y}
-  end
 end

lib/matplotex/element/slice.ex

@@ -37,8 +37,4 @@ defmodule Matplotex.Element.Slice do
   def get_cx(%{cx: cx}), do: to_pixel(cx)
   def get_cy(%{cy: cy}), do: to_pixel(cy)
   def get_radius(%{radius: radius}), do: to_pixel(radius)
-  @impl Element
-  def flipy(slice, _height) do
-    slice
-  end
 end