Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
ISimpleTableInternalComparator.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* ISimpleTableInternalComparator.h (C) 2000-2025 */
9/* */
10/* Interface representing a SimpleTableInternal comparator. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_ISIMPLETABLEINTERNALCOMPARATOR_H
13#define ARCANE_CORE_ISIMPLETABLEINTERNALCOMPARATOR_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/core/ISimpleTableInternalMng.h"
18
20
21/*---------------------------------------------------------------------------*/
22/*---------------------------------------------------------------------------*/
23
24namespace Arcane
25{
26
27/*---------------------------------------------------------------------------*/
28/*---------------------------------------------------------------------------*/
29
62class ARCANE_CORE_EXPORT ISimpleTableInternalComparator
63{
64 public:
65
66 virtual ~ISimpleTableInternalComparator() = default;
67
68 public:
69
77 virtual bool compare(bool compare_dimension_too = false) = 0;
78
91 virtual bool compareElem(const String& column_name, const String& row_name) = 0;
92
103 virtual bool compareElem(Real elem, const String& column_name, const String& row_name) = 0;
104
109 virtual void clearComparator() = 0;
110
118 virtual bool addColumnForComparing(const String& column_name) = 0;
126 virtual bool addRowForComparing(const String& row_name) = 0;
127
135 virtual void isAnArrayExclusiveColumns(bool is_exclusive) = 0;
136
144 virtual void isAnArrayExclusiveRows(bool is_exclusive) = 0;
145
152 virtual void editRegexColumns(const String& regex_column) = 0;
159 virtual void editRegexRows(const String& regex_row) = 0;
160
167 virtual void isARegexExclusiveColumns(bool is_exclusive) = 0;
174 virtual void isARegexExclusiveRows(bool is_exclusive) = 0;
175
190 virtual bool addEpsilonColumn(const String& column_name, Real epsilon) = 0;
191
205 virtual bool addEpsilonRow(const String& row_name, Real epsilon) = 0;
206
214
221 virtual void setInternalRef(const Ref<SimpleTableInternal>& simple_table_internal) = 0;
222
230
237 virtual void setInternalToCompare(const Ref<SimpleTableInternal>& simple_table_internal) = 0;
238};
239
240/*---------------------------------------------------------------------------*/
241/*---------------------------------------------------------------------------*/
242
243} // End namespace Arcane
244
245/*---------------------------------------------------------------------------*/
246/*---------------------------------------------------------------------------*/
247
248#endif
Declarations of types on entities.
Class interface representing a SimpleTableInternal comparator (aka STI).
virtual void setInternalRef(const Ref< SimpleTableInternal > &simple_table_internal)=0
Method allowing definition of a reference to a "reference" SimpleTableInternal.
virtual bool addRowForComparing(const String &row_name)=0
Method allowing the addition of a row to the list of rows to compare.
virtual void isAnArrayExclusiveRows(bool is_exclusive)=0
Method allowing definition of whether the row array represents rows to include in the comparison (fal...
virtual void setInternalToCompare(const Ref< SimpleTableInternal > &simple_table_internal)=0
Method allowing definition of a reference to the "to compare" SimpleTableInternal.
virtual void isARegexExclusiveRows(bool is_exclusive)=0
Method allowing specification that the regular expression excludes rows instead of including them.
virtual Ref< SimpleTableInternal > internalRef()=0
Method allowing retrieval of a reference to the used "reference" SimpleTableInternal object.
virtual Ref< SimpleTableInternal > internalToCompare()=0
Method allowing retrieval of a reference to the used "to compare" SimpleTableInternal object.
virtual bool addEpsilonRow(const String &row_name, Real epsilon)=0
Method allowing the definition of an epsilon for a given row. This epsilon must be positive to be con...
virtual bool compare(bool compare_dimension_too=false)=0
Method allowing comparison of the values of the two STIs.
virtual void editRegexColumns(const String &regex_column)=0
Method allowing the addition of a regular expression to determine the columns to compare.
virtual void editRegexRows(const String &regex_row)=0
Method allowing the addition of a regular expression to determine the rows to compare.
virtual bool compareElem(const String &column_name, const String &row_name)=0
Method allowing comparison of a single element. Both SimpleTableInternals are represented by Refs,...
virtual bool addEpsilonColumn(const String &column_name, Real epsilon)=0
Method allowing the definition of an epsilon for a given column. This epsilon must be positive to be ...
virtual void isARegexExclusiveColumns(bool is_exclusive)=0
Method allowing specification that the regular expression excludes columns instead of including them.
virtual bool addColumnForComparing(const String &column_name)=0
Method allowing the addition of a column to the list of columns to compare.
virtual void clearComparator()=0
Method allowing the clearing of comparison arrays and regular expressions. Does not affect the STIs.
virtual void isAnArrayExclusiveColumns(bool is_exclusive)=0
Method allowing definition of whether the column array represents columns to include in the compariso...
virtual bool compareElem(Real elem, const String &column_name, const String &row_name)=0
Method allowing comparison of a value with a value from the reference table. This method does not use...
Reference to an instance.
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
double Real
Type representing a real number.