lumiera_/tests/library/gnuplot-gen-test.cpp

/*
  GnuplotGen(Test)  -  verify the minimalistic text substitution engine

  Copyright (C)         Lumiera.org
    2024,               Hermann Vosseler <Ichthyostega@web.de>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

* *****************************************************/

/** @file gnuplot-gen-test.cpp
 ** unit test \ref GnuplotGen_test
 */



#include "lib/test/run.hpp"
#include "lib/test/test-helper.hpp"///////////////////////TODO
#include "lib/gnuplot-gen.hpp"
#include "lib/iter-explorer.hpp"
#include "lib/format-cout.hpp"///////////////////////TODO
#include "lib/test/diagnostic-output.hpp"///////////////////////TODO

using lib::stat::CSVData;
using util::contains;

namespace lib {
namespace test{
  
  
  
  /***************************************************************************//**
   * @test verify data visualisation by generated Gnuplot scripts
   *       - generate a simple pot
   *       - generate a scatter plot with regression line
   * @see  gnuplot-gen.hpp
   * @see  TextTemplate_test
   */
  class GnuplotGen_test : public Test
    {
      
      virtual void
      run (Arg)
        {
          simpeUsage();
          plot_scatter_regression();
          verify_keySubstituton();
          verify_conditional();
          verify_iteration();
          verify_Map_binding();
          verify_ETD_binding();

        }
      
      
      /** @test Create simple (x,y) data point visualisation
       * @todo WIP 4/24 ✔ define ⟶ ✔ implement
       */
      void
      simpeUsage()
        {
          string gnuplot = gnuplot_gen::dataPlot(
              CSVData{{"step","fib"}
                     ,{{0,1}
                      ,{1,1}
                      ,{2,2}
                      ,{3,3}
                      ,{4,5}
                      ,{5,8}
                      ,{6,13}
                      ,{7,21.55}
                     }});
//        cout << gnuplot <<endl;
          //Hint: gnuplot -p <scriptfile>
          
          CHECK (contains (gnuplot, "set datafile separator \",;\""));
          CHECK (contains (gnuplot, "\"step\",\"fib\""));
          CHECK (contains (gnuplot, "7,21.55"));
          CHECK (contains (gnuplot, "set key autotitle columnheader"));
          CHECK (contains (gnuplot, "plot for [i=2:*] $RunData using 1:i with points"));
        }
      
      
      
      /** @test Create a (x,y) scatter plot with regression line
       *      - in the simple case, there is only one diagram
       *      - use the `stats` command to let Gnuplot calculate the linear regression
       *      - draw a regrsssion line using the `arrow` command
       *        and a function representing the linear regression model
       * @todo WIP 4/24 🔁 define ⟶ ✔ implement
       */
      void
      plot_scatter_regression()
        {
          string gnuplot = gnuplot_gen::scatterRegression(
              CSVData{{"step","fib"}
                     ,{{0,1}
                      ,{1,1}
                      ,{2,2}
                      ,{3,3}
                      ,{4,5}
                      ,{5,8}
                      ,{6,13}
                      ,{7,21.55}
                     }});
          cout << gnuplot <<endl;
          
          CHECK (contains (gnuplot, "\"step\",\"fib\""));
          CHECK (contains (gnuplot, "7,21.55"));
          CHECK (contains (gnuplot, "regLine(x) = STATS_slope * x + STATS_intercept"));
          CHECK (contains (gnuplot, "set arrow 1 from graph 0, first regLine(STATS_min_x)"));
          CHECK (contains (gnuplot, "plot $RunData using 1:2 with points"));
          
          // only one data row given => no multiplot layout
          CHECK (not contains (gnuplot, "set multiplot"));
        }
      
      
      /** @test TODO
       * @todo WIP 4/24 🔁 define ⟶ implement
       */
      void
      verify_keySubstituton()
        {
          UNIMPLEMENTED ("nebbich");
        }
      
      
      /** @test TODO
       * @todo WIP 4/24 🔁 define ⟶ implement
       */
      void
      verify_conditional()
        {
        }
      
      
      /** @test TODO
       * @todo WIP 4/24 🔁 define ⟶ implement
       */
      void
      verify_iteration()
        {
        }
      
      
      /** @test TODO
       * @todo WIP 4/24 🔁 define ⟶ implement
       */
      void
      verify_Map_binding()
        {
        }
      
      
      /** @test TODO
       * @todo WIP 4/24 🔁 define ⟶ implement
       */
      void
      verify_ETD_binding()
        {
        }
    };
  
  LAUNCHER (GnuplotGen_test, "unit common");
  
  
}} // namespace lib::test