mat_latex.H

Go to the documentation of this file.

 
/*
                          Aleph_w
 
  Data structures & Algorithms
  version 2.0.0b
  https://github.com/lrleon/Aleph-w
 
  This file is part of Aleph-w library
 
  Copyright (c) 2002-2026 Leandro Rabindranath Leon
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
 
 
#ifndef MAT_LATEX_H
#define MAT_LATEX_H
 
#include <fstream>
#include <ostream>
#include <string>
 
namespace Aleph
{
 
template <typename Mat,
          class RowIndexFormatter,
          class ColIndexFormatter,
          class EntryFormatter>
void mat_to_latex(Mat & mat,
                  long n,
                  long m,
                  std::ostream & out,
                  const std::string & prefix = "",
                  const std::string & suffix = "")
{
  out << prefix;
  out << "\\begin{tabular}{|c|";
  
  for (long j = 0; j < m; ++j)
    out << "p{1mm}";
  
  out << "|} \\hline\n& ";
 
  // Column headers
  for (long j = 0; j < m; ++j)
    {
      out << ColIndexFormatter()(mat, j);
      if (j < m - 1)
        out << " & ";
      else
        out << "\\\\ \\hline\n";
    }
 
  // Matrix rows
  for (long i = 0; i < n; ++i)
    {
      out << RowIndexFormatter()(mat, i) << " & ";
      
      for (long j = 0; j < m; ++j)
        {
          out << EntryFormatter()(mat, i, j);
          if (j < m - 1)
            out << " & ";
        }
 
      out << "\\\\\n";
    }
 
  out << "\\hline\\end{tabular}\n" << suffix;
}
 
template <typename Mat,
          class RowIndexFormatter,
          class ColIndexFormatter,
          class EntryFormatter>
void mat_to_latex(Mat & mat,
                  long n,
                  long m,
                  std::ofstream & out,
                  const std::string & prefix = "",
                  const std::string & suffix = "")
{
  mat_to_latex<Mat, RowIndexFormatter, ColIndexFormatter, EntryFormatter>(
      mat, n, m, static_cast<std::ostream&>(out), prefix, suffix);
}
 
template <typename Mat>
struct Default_Row_Formatter
{
  std::string operator()(Mat &, long i) const
  {
    return std::to_string(i);
  }
};
 
template <typename Mat>
struct Default_Col_Formatter
{
  std::string operator()(Mat &, long j) const
  {
    return std::to_string(j);
  }
};
 
template <typename Mat>
struct Default_Entry_Formatter
{
  std::string operator()(Mat & mat, long i, long j) const
  {
    std::ostringstream ss;
    ss << mat(i, j);
    return ss.str();
  }
};
 
template <typename Mat>
void mat_to_latex_simple(Mat & mat,
                         long n,
                         long m,
                         std::ostream & out,
                         const std::string & prefix = "",
                         const std::string & suffix = "")
{
  mat_to_latex<Mat,
               Default_Row_Formatter<Mat>,
               Default_Col_Formatter<Mat>,
               Default_Entry_Formatter<Mat>>(mat, n, m, out, prefix, suffix);
}
 
} // namespace Aleph
 
// Global namespace compatibility
using Aleph::mat_to_latex;
using Aleph::mat_to_latex_simple;
using Aleph::Default_Row_Formatter;
using Aleph::Default_Col_Formatter;
using Aleph::Default_Entry_Formatter;
 
#endif // MAT_LATEX_H