graph.cpp

// This file is part of Hermes2D.
//
// Hermes2D 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.
//
// Hermes2D 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 Hermes2D.  If not, see <http://www.gnu.org/licenses/>.

#include "global.h"
#include "graph.h"
namespace Hermes
{
  namespace Hermes2D
  {
    Graph::Graph(const char* title, const char* x_axis_name, const char* y_axis_name)
    {
      set_captions(title, x_axis_name, y_axis_name);
      logx = logy = false;
      legend = grid = true;
    }

    void Graph::set_log_x(bool log)
    {
      logx = log;
    }

    void Graph::set_log_y(bool log)
    {
      logy = log;
    }

    void Graph::show_legend(bool show)
    {
      legend = show;
    }

    void Graph::show_grid(bool show)
    {
      grid = show;
    }

    void Graph::set_captions(const char* title, const char* x_axis_name, const char* y_axis_name)
    {
      this->title = title ? title : "";
      xname = x_axis_name ? x_axis_name : "";
      yname = y_axis_name ? y_axis_name : "";
    }

    int Graph::add_row(const char* name, const char* color, const char* line, const char* marker)
    {
      Row row;
      if (name == nullptr) name = "";
      row.name = name;
      row.color = "k";
      row.line = "-";
      row.marker = "";

      rows.push_back(row);
      set_row_style(rows.size() - 1, color, line, marker);
      return rows.size() - 1;
    }

    void Graph::set_row_style(int row, const char* color, const char* line, const char* marker)
    {
      if (!rows.size()) add_row(nullptr);
      rows[row].color = color;
      rows[row].line = line;
      rows[row].marker = marker;
    }

    void Graph::add_values(int row, double x, double y)
    {
      if (!rows.size()) add_row(nullptr);
      // this is to avoid problems with plotting in log-log scale
      if (fabs(x) < Hermes::HermesSqrtEpsilon) return;
      // (sometimes the CPU time was zero and plotting crashed)
      if (row < 0 || row >= (int)rows.size()) throw Hermes::Exceptions::Exception("Invalid row number.");
      Values xy = { x, y };
      rows[row].data.push_back(xy);
    }

    void Graph::add_values(double x, double y)
    {
      int row = 0;
      if (!rows.size()) add_row(nullptr);
      // this is to avoid problems with plotting in log-log scale
      if (fabs(x) < Hermes::HermesSqrtEpsilon) return;
      // (sometimes the CPU time was zero and plotting crashed)
      Values xy = { x, y };
      rows[row].data.push_back(xy);
    }

    void Graph::add_values(int row, int n, double* x, double* y)
    {
      for (int i = 0; i < n; i++)
        add_values(row, x[i], y[i]);
    }

    void Graph::add_values(int row, int n, double2* xy)
    {
      for (int i = 0; i < n; i++)
        add_values(row, xy[i][0], xy[i][1]);
    }

    void Graph::save_numbered(const char* filename, int number)
    {
      char buffer[1000];
      sprintf(buffer, filename, number);
      save(buffer);
    }

    void SimpleGraph::save(const char* filename)
    {
      if (!rows.size()) throw Hermes::Exceptions::Exception("No data rows defined.");

      FILE* f = fopen(filename, "w");
      if (f == nullptr) throw Hermes::Exceptions::Exception("Error writing to %s.", filename);

      for (unsigned int i = 0; i < rows.size(); i++)
      {
        int rsize = rows[i].data.size();
        for (int j = 0; j < rsize; j++)
          fprintf(f, "%.14g  %.14g\n", rows[i].data[j].x, rows[i].data[j].y);
      }

      fclose(f);

      this->info("Graph saved to file '%s'.", filename);
    }

    void MatlabGraph::save(const char* filename)
    {
      int j, k;

      if (!rows.size()) throw Hermes::Exceptions::Exception("No data rows defined.");

      FILE* f = fopen(filename, "w");
      if (f == nullptr) throw Hermes::Exceptions::Exception("Error writing to %s", filename);

      if (!logx && !logy)
        fprintf(f, "plot(");
      else if (logx && !logy)
        fprintf(f, "semilogx(");
      else if (!logx && logy)
        fprintf(f, "semilogy(");
      else
        fprintf(f, "loglog(");

      for (unsigned int i = 0; i < rows.size(); i++)
      {
        fprintf(f, "[");
        int rsize = rows[i].data.size();
        for (k = 0; k < 2; k++)
        {
          for (j = 0; j < rsize; j++)
          {
            fprintf(f, "%.14g", k ? rows[i].data[j].y : rows[i].data[j].x);
            if (j < rsize - 1) fprintf(f, ", ");
          }
          fprintf(f, (!k ? "],[" : "], '"));
        }
        fprintf(f, "%s%s%s'", rows[i].color.c_str(), rows[i].line.c_str(), rows[i].marker.c_str());
        if (i < rows.size() - 1) fprintf(f, ", ");
      }
      fprintf(f, ");\n");

      if (title.length()) fprintf(f, "title('%s');\n", title.c_str());
      if (xname.length()) fprintf(f, "xlabel('%s');\n", xname.c_str());
      if (yname.length()) fprintf(f, "ylabel('%s');\n", yname.c_str());

      if (legend && (rows.size() > 1 || rows[0].name.length()))
      {
        fprintf(f, "legend(");
        for (unsigned int i = 0; i < rows.size(); i++)
        {
          fprintf(f, "'%s'", rows[i].name.c_str());
          if (i < rows.size() - 1) fprintf(f, ", ");
        }
        fprintf(f, ");\n");
      }
      else
        fprintf(f, "legend off;\n");

      fprintf(f, "grid %s;\n", grid ? "on" : "off");

      fclose(f);

      this->info("Graph saved. Run the file '%s' in Matlab.", filename);
    }

    static void get_style_types(std::string line, std::string mark, std::string col, int& lt, int& pt, int& ct)
    {
      if (line == "-")
        // solid
        lt = 1;
      else if (line == ":")
        // dotted
        lt = 4;
      else if (line == "-.")
        // dash dot
        lt = 5;
      else if (line == "--")
        // dashed
        lt = 2;
      else
        lt = 1;

      // full circle
      if (mark == ".") pt = 7;
      // empty circle
      else if (mark == "o") pt = 6;
      // full circle
      else if (mark == "O") pt = 7;
      // cross
      else if (mark == "x") pt = 2;
      // cross
      else if (mark == "+") pt = 1;
      // star
      else if (mark == "*") pt = 3;
      // empty square
      else if (mark == "s") pt = 4;
      // full square
      else if (mark == "S") pt = 5;
      // empty diamond
      else if (mark == "d") pt = 10;
      // full diamond
      else if (mark == "D") pt = 11;
      // empty triangle down
      else if (mark == "v") pt = 12;
      // full triangle down
      else if (mark == "V") pt = 13;
      // full triangle up
      else if (mark == "^") pt = 9;
      // empty triangle down
      else if (mark == "<") pt = 12;
      // empty triangle up
      else if (mark == ">") pt = 8;
      // empty pentagon
      else if (mark == "p") pt = 14;
      // full pentagon
      else if (mark == "P") pt = 15;
      else pt = 0;

      // black
      if (col == "k") ct = -1;
      // blue
      else if (col == "b") ct = 3;
      // green
      else if (col == "g") ct = 2;
      // cyan
      else if (col == "c") ct = 5;
      // magenta
      else if (col == "m") ct = 4;
      // yellow
      else if (col == "y") ct = 6;
      // red
      else if (col == "r") ct = 1;
      else ct = -1;
    }

    void GnuplotGraph::set_legend_pos(const char* posspec)
    {
      legend_pos = posspec;
      if (legend_pos.length() && !legend) legend = true;
    }

    void GnuplotGraph::save(const char* filename)
    {
      int j;

      if (!rows.size()) throw Hermes::Exceptions::Exception("No data rows defined.");

      FILE* f = fopen(filename, "w");
      if (f == nullptr) throw Hermes::Exceptions::Exception("Error writing to %s", filename);

      fprintf(f, "%s", terminal_str.c_str());

      int len = strlen(filename);
      char* outname = malloc_with_check<char>(len + 10);
      strcpy(outname, filename);
      char* slash = strrchr(outname, '/');
      if (slash != nullptr) strcpy(outname, ++slash);
      char* dot = strrchr(outname, '.');
      if (dot != nullptr && dot > outname) *dot = 0;
      strcat(outname, ".eps");

      fprintf(f, "set output '%s'\n", (char*)outname);
      free_with_check(outname);

      fprintf(f, "set size 0.8, 0.8\n");

      if (logx && !logy)
        fprintf(f, "set logscale x\n");
      else if (!logx && logy)
        fprintf(f, "set logscale y\n");
      else if (logx && logy)
      {
        fprintf(f, "set logscale x\n");
        fprintf(f, "set logscale y\n");
      }

      if (grid) fprintf(f, "set grid\n");

      if (title.length()) fprintf(f, "set title '%s'\n", title.c_str());
      if (xname.length()) fprintf(f, "set xlabel '%s'\n", xname.c_str());
      if (yname.length()) fprintf(f, "set ylabel '%s'\n", yname.c_str());
      if (legend && legend_pos.length()) fprintf(f, "set key %s\n", legend_pos.c_str());

      fprintf(f, "plot");
      for (unsigned int i = 0; i < rows.size(); i++)
      {
        int ct, lt, pt;
        get_style_types(rows[i].line, rows[i].marker, rows[i].color, lt, pt, ct);

        if (lt == 0)
          fprintf(f, " '-' w p pointtype %d", pt);
        else if (ct < 0)
          fprintf(f, " '-' w lp linewidth %g linetype %d pointtype %d", this->lw, lt, pt);
        else
          fprintf(f, " '-' w lp linewidth %g linecolor %d linetype %d pointtype %d", this->lw, ct, lt, pt);

        if (legend)
          fprintf(f, " title '%s' ", rows[i].name.c_str());
        else
          fprintf(f, " notitle ");

        if (i < rows.size() - 1) fprintf(f, ",\\\n     ");
      }
      fprintf(f, "\n");

      for (unsigned int i = 0; i < rows.size(); i++)
      {
        int rsize = rows[i].data.size();
        for (j = 0; j < rsize; j++)
          fprintf(f, "%.14g  %.14g\n", rows[i].data[j].x, rows[i].data[j].y);
        fprintf(f, "e\n");
      }

      fprintf(f, "set terminal x11\n");
      fclose(f);

      this->info("Graph saved. Process the file '%s' with gnuplot.", filename);
    }

    PNGGraph::PNGGraph(const char* title, const char* x_axis_name, const char* y_axis_name, const double lines_width,
      double plot_width, double plot_height) : GnuplotGraph(title, x_axis_name, y_axis_name, lines_width)
    {
      std::stringstream sstm;
      sstm << "set terminal png font arial 12 size " << plot_width << "," << plot_height << " crop enhanced\n";
      terminal_str = sstm.str();
    }
  }
}