TableData.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_COMMON_FORMAT_TABLE_TABLEDATA_HPP
#define GEOS_COMMON_FORMAT_TABLE_TABLEDATA_HPP
 
#include "common/Units.hpp"
#include "common/DataTypes.hpp"
#include "common/format/Format.hpp"
#include "TableTypes.hpp"
 
namespace geos
{
 
class TableData
{
public:
 
  TableData();
 
  TableData( TableData const & other );
 
  TableData( TableData && other );
 
  TableData & operator=( TableData const & other );
 
  TableData & operator=( TableData && other );
 
  bool operator<( TableData const & other ) const;
 
  struct CellData
  {
    CellType type;
    string value;
 
    bool operator==( CellData const & other ) const
    {
      return value == other.value;
    }
 
    bool operator<( CellData const & other ) const
    {
      return value < other.value;
    }
  };
 
  using DataRows = stdVector< stdVector< CellData > >;
 
  template< typename ... Args >
  void addRow( Args const & ... args );
 
  void addRow( stdVector< CellData > const & row );
 
  void addSeparator();
 
  void clear();
 
  void clearErrors()
  { m_errors->clear(); }
 
  stdVector< stdVector< CellData > > const & getTableDataRows() const;
 
  stdVector< stdVector< CellData > > & getTableDataRows();
 
  stdVector< string > const & getErrorMsgs() const;
 
  DataRows const & getCellsData() const
  { return m_rows; }
 
  inline bool operator==( TableData const & comparingTable ) const
  {
 
    return getCellsData() == comparingTable.getCellsData();
  }
 
  TableErrorListing const & getErrorsList() const
  { return *m_errors; }
 
  TableErrorListing & getErrorsList()
  { return *m_errors; }
 
private:
  DataRows m_rows;
 
  std::unique_ptr< geos::TableErrorListing > m_errors;
 
};
 
 
class TableData2D
{
public:
 
  using RowType = real64;
  using ColumnType = real64;
 
  struct TableDataHolder
  {
    stdVector< string > headerNames;
    TableData tableData;
  };
 
  template< typename T >
  void addCell( RowType rowValue, ColumnType columnValue, T const & value );
 
  void collectTableValues( arrayView1d< real64 const > dim0AxisCoordinates,
                           arrayView1d< real64 const > dim1AxisCoordinates,
                           arrayView1d< real64 const > values,
                           bool columnMajorValues );
 
  TableData2D::TableDataHolder convertTable2D( arrayView1d< real64 const > coordX, arrayView1d< real64 const > coordY,
                                               string_view rowAxisDescription,
                                               string_view columnAxisDescription,
                                               arrayView1d< real64 const > const values,
                                               bool columnMajorValues,
                                               string_view valueDescription );
 
  TableDataHolder buildTableData( string_view dataDescription,
                                  string_view rowFmt = "{}", string_view columnFmt = "{}" ) const;
 
  inline void clear()
  {
    m_data.clear();
    m_columnValues.clear();
    m_errors->clear();
  }
 
private:
  std::map< RowType, std::map< ColumnType, string > > m_data;
  std::set< real64 > m_columnValues;
  std::unique_ptr< geos::TableErrorListing > m_errors = std::make_unique< geos::TableErrorListing >();
};
 
template< typename T >
constexpr bool isCellType = std::is_same_v< T, CellType >;
 
template< typename ... Args >
void TableData::addRow( Args const &... args )
{
  stdVector< CellData > cells;
  ( [&] {
    static_assert( has_formatter_v< decltype(args) > || isCellType< std::decay_t< decltype(args) > >, "Argument passed in addRow cannot be converted to string nor a CellType" );
    if constexpr (std::is_same_v< Args, CellType >) {
      cells.push_back( { args, string() } );
    }
    else if constexpr (std::is_floating_point_v< std::decay_t< decltype(args) > >) {
      if( !getErrorsList().hasErrors() && (std::isnan( args ) ||  std::isinf( args )))
      {
        m_errors->addError( "Warning : Invalid values detected (nan/inf)." );
      }
      cells.push_back( {CellType::Value, GEOS_FMT( "{}", args )} );
    }
    else
    {
      cells.push_back( {CellType::Value, GEOS_FMT( "{}", args )} );
    }
  } (), ...);
  addRow( cells );
}
 
template< typename T >
void TableData2D::addCell( real64 const rowValue, real64 const columnValue, T const & value )
{
  static_assert( has_formatter_v< decltype(value) >, "Argument passed in addCell cannot be converted to string" );
  m_columnValues.insert( columnValue );
  m_data[rowValue][columnValue] = GEOS_FMT( "{}", value );
}
 
}
#endif /* GEOS_COMMON_FORMAT_TABLE_TABLEDATA_HPP */