ISimpleTableComparator.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ISimpleTableComparator.h                                    (C) 2000-2025 */
/*                                                                           */
/* Interface for services allowing the comparison of an ISimpleTableOutput   */
/* and a reference file.                                                     */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ISIMPLETABLECOMPARATOR_H
#define ARCANE_CORE_ISIMPLETABLECOMPARATOR_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ISimpleTableOutput.h"
 
#include "arcane/core/ItemTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT ISimpleTableComparator
{
 public:
 
  virtual ~ISimpleTableComparator() = default;
 
 public:

  virtual void init(ISimpleTableOutput* simple_table_output_ptr) = 0;

  virtual void clear() = 0;

  virtual void print(Integer rank = 0) = 0;

  virtual void editRootDirectory(const Directory& root_directory) = 0;

  virtual bool writeReferenceFile(Integer rank = -1) = 0;

  virtual bool readReferenceFile(Integer rank = -1) = 0;

  virtual bool isReferenceExist(Integer rank = -1) = 0;

  virtual bool compareWithReference(Integer rank = -1, bool compare_dimension_too = false) = 0;

  virtual bool compareElemWithReference(const String& column_name, const String& row_name, Integer rank = -1) = 0;

  virtual bool compareElemWithReference(Real elem, const String& column_name, const String& row_name, Integer rank = -1) = 0;

  virtual bool addColumnForComparing(const String& column_name) = 0;
  virtual bool addRowForComparing(const String& row_name) = 0;

  virtual void isAnArrayExclusiveColumns(bool is_exclusive) = 0;

  virtual void isAnArrayExclusiveRows(bool is_exclusive) = 0;

  virtual void editRegexColumns(const String& regex_column) = 0;
  virtual void editRegexRows(const String& regex_row) = 0;

  virtual void isARegexExclusiveColumns(bool is_exclusive) = 0;
  virtual void isARegexExclusiveRows(bool is_exclusive) = 0;

  virtual bool addEpsilonColumn(const String& column_name, Real epsilon) = 0;

  virtual bool addEpsilonRow(const String& row_name, Real epsilon) = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif