Arcane  v3.14.10.0
Documentation développeur
Chargement...
Recherche...
Aucune correspondance
Référence de la classe Arcane::SimpleTableInternalComparator
+ Graphe d'héritage de Arcane::SimpleTableInternalComparator:
+ Graphe de collaboration de Arcane::SimpleTableInternalComparator:

Fonctions membres publiques

 SimpleTableInternalComparator (const Ref< SimpleTableInternal > &sti_ref, const Ref< SimpleTableInternal > &sti_to_compare)
 
bool compare (bool compare_dimension_too) override
 Méthode permettant de comparer les valeurs des deux STI.
 
bool compareElem (const String &column_name, const String &row_name) override
 Méthode permettant de comparer uniquement un élement. Les deux SimpleTableInternal sont représentés par des Ref, donc toujours à jour. Cette méthode peut être utilisé pendant le calcul, permettant de comparer les valeurs au fur et à mesure de l'avancement du calcul, au lieu de faire une comparaison final à la fin (il est tout de même possible de faire les deux).
 
bool compareElem (Real elem, const String &column_name, const String &row_name) override
 Méthode permettant de comparer une valeur avec une valeur du tableau de référence. Cette méthode n'utilise pas l'internal 'toCompare'.
 
void clearComparator () override
 Méthode permettant de vider les tableaux de comparaison et les expressions régulières. Ne touche pas aux STI.
 
bool addColumnForComparing (const String &column_name) override
 Méthode permettant d'ajouter une colonne dans la liste des colonnes à comparer.
 
bool addRowForComparing (const String &row_name) override
 Méthode permettant d'ajouter une ligne dans la liste des lignes à comparer.
 
void isAnArrayExclusiveColumns (bool is_exclusive) override
 Méthode permettant de définir si le tableau de colonnes représente les colonnes à inclure dans la comparaison (false/par défaut) ou représente les colonnes à exclure de la comparaison (true).
 
void isAnArrayExclusiveRows (bool is_exclusive) override
 Méthode permettant de définir si le tableau de lignes représente les lignes à inclure dans la comparaison (false/par défaut) ou représente les lignes à exclure de la comparaison (true).
 
void editRegexColumns (const String &regex_column) override
 Méthode permettant d'ajouter une expression régulière permettant de déterminer les colonnes à comparer.
 
void editRegexRows (const String &regex_row) override
 Méthode permettant d'ajouter une expression régulière permettant de déterminer les lignes à comparer.
 
void isARegexExclusiveColumns (bool is_exclusive) override
 Méthode permettant de demander à ce que l'expression régulière exclut des colonnes au lieu d'en inclure.
 
void isARegexExclusiveRows (bool is_exclusive) override
 Méthode permettant de demander à ce que l'expression régulière exclut des lignes au lieu d'en inclure.
 
bool addEpsilonColumn (const String &column_name, Real epsilon) override
 Méthode permettant de définir un epsilon pour une colonne donnée. Cet epsilon doit être positif pour être pris en compte. S'il y a confit avec un epsilon de ligne (défini avec addEpsilonRow()), c'est l'epsilon le plus grand qui est pris en compte.
 
bool addEpsilonRow (const String &row_name, Real epsilon) override
 Méthode permettant de définir un epsilon pour une ligne donnée. Cet epsilon doit être positif pour être pris en compte. S'il y a confit avec un epsilon de colonne (défini avec addEpsilonColumn()), c'est l'epsilon le plus grand qui est pris en compte.
 
Ref< SimpleTableInternalinternalRef () override
 Méthode permettant de récupérer une référence vers l'objet SimpleTableInternal "de référence" utilisé.
 
void setInternalRef (const Ref< SimpleTableInternal > &simple_table_internal) override
 Méthode permettant de définir une référence vers un SimpleTableInternal "de référence".
 
Ref< SimpleTableInternalinternalToCompare () override
 Méthode permettant de récupérer une référence vers l'objet SimpleTableInternal "à comparer" utilisé.
 
void setInternalToCompare (const Ref< SimpleTableInternal > &simple_table_internal) override
 Méthode permettant de définir une référence vers SimpleTableInternal "à comparer".
 

Fonctions membres protégées

bool _exploreColumn (const String &column_name)
 Méthode permettant de savoir si la colonne avec le nom column_name doit être exploré ou non.
 
bool _exploreRows (const String &row_name)
 Méthode permettant de savoir si la ligne avec le nom column_name doit être exploré ou non.
 

Attributs protégés

Ref< SimpleTableInternalm_simple_table_internal_reference
 
Ref< SimpleTableInternalm_simple_table_internal_to_compare
 
SimpleTableInternalMng m_simple_table_internal_mng_reference
 
SimpleTableInternalMng m_simple_table_internal_mng_to_compare
 
String m_regex_rows
 
bool m_is_excluding_regex_rows
 
String m_regex_columns
 
bool m_is_excluding_regex_columns
 
StringUniqueArray m_rows_to_compare
 
bool m_is_excluding_array_rows
 
StringUniqueArray m_columns_to_compare
 
bool m_is_excluding_array_columns
 
std::map< String, Real > m_epsilons_column
 
std::map< String, Real > m_epsilons_row
 

Description détaillée

Définition à la ligne 39 du fichier SimpleTableInternalComparator.h.

Documentation des constructeurs et destructeur

◆ SimpleTableInternalComparator() [1/2]

Arcane::SimpleTableInternalComparator::SimpleTableInternalComparator ( const Ref< SimpleTableInternal > &  sti_ref,
const Ref< SimpleTableInternal > &  sti_to_compare 
)
inline

Définition à la ligne 43 du fichier SimpleTableInternalComparator.h.

◆ SimpleTableInternalComparator() [2/2]

Arcane::SimpleTableInternalComparator::SimpleTableInternalComparator ( )
inline

Définition à la ligne 61 du fichier SimpleTableInternalComparator.h.

Documentation des fonctions membres

◆ _exploreColumn()

bool Arcane::SimpleTableInternalComparator::_exploreColumn ( const String column_name)
protected

Méthode permettant de savoir si la colonne avec le nom column_name doit être exploré ou non.

Paramètres
column_nameLe nom de la colonne à verifier.
Renvoie
true Si la colonne doit être vérifiée.
false Si la colonne ne doit pas être vérifiée.

Définition à la ligne 267 du fichier SimpleTableInternalComparator.cc.

Références Arccore::AbstractArray< T >::contains(), Arccore::String::empty(), Arccore::AbstractArray< T >::empty(), et Arccore::String::localstr().

Référencé par compare().

◆ _exploreRows()

bool Arcane::SimpleTableInternalComparator::_exploreRows ( const String row_name)
protected

Méthode permettant de savoir si la ligne avec le nom column_name doit être exploré ou non.

Paramètres
column_nameLe nom de la ligne à verifier.
Renvoie
true Si la ligne doit être vérifiée.
false Si la ligne ne doit pas être vérifiée.

Définition à la ligne 305 du fichier SimpleTableInternalComparator.cc.

Références Arccore::AbstractArray< T >::contains(), Arccore::String::empty(), Arccore::AbstractArray< T >::empty(), et Arccore::String::localstr().

Référencé par compare().

◆ addColumnForComparing()

bool Arcane::SimpleTableInternalComparator::addColumnForComparing ( const String column_name)
overridevirtual

Méthode permettant d'ajouter une colonne dans la liste des colonnes à comparer.

Paramètres
column_nameLe nom de la colonne à comparer.
Renvoie
true Si le nom a bien été ajouté.
false Sinon.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 160 du fichier SimpleTableInternalComparator.cc.

Références Arccore::Array< T >::add().

Référencé par Arcane::SimpleCsvComparatorService::addColumnForComparing().

◆ addEpsilonColumn()

bool Arcane::SimpleTableInternalComparator::addEpsilonColumn ( const String column_name,
Real  epsilon 
)
overridevirtual

Méthode permettant de définir un epsilon pour une colonne donnée. Cet epsilon doit être positif pour être pris en compte. S'il y a confit avec un epsilon de ligne (défini avec addEpsilonRow()), c'est l'epsilon le plus grand qui est pris en compte.

Note
Si un epsilon a déjà été défini sur cette colonne, alors l'ancien epsilon sera remplacé.
Paramètres
column_nameLe nom de la colonne où l'epsilon sera pris en compte.
epsilonLa marge d'erreur epsilon.
Renvoie
true Si l'epsilon a bien pu être défini.
false Si l'epsilon n'a pas pu être défini.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 209 du fichier SimpleTableInternalComparator.cc.

Référencé par Arcane::SimpleCsvComparatorService::addEpsilonColumn().

◆ addEpsilonRow()

bool Arcane::SimpleTableInternalComparator::addEpsilonRow ( const String row_name,
Real  epsilon 
)
overridevirtual

Méthode permettant de définir un epsilon pour une ligne donnée. Cet epsilon doit être positif pour être pris en compte. S'il y a confit avec un epsilon de colonne (défini avec addEpsilonColumn()), c'est l'epsilon le plus grand qui est pris en compte.

Note
Si un epsilon a déjà été défini sur cette ligne, alors l'ancien epsilon sera remplacé.
Paramètres
column_nameLe nom de la ligne où l'epsilon sera pris en compte.
epsilonLa marge d'erreur epsilon.
Renvoie
true Si l'epsilon a bien pu être défini.
false Si l'epsilon n'a pas pu être défini.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 216 du fichier SimpleTableInternalComparator.cc.

Référencé par Arcane::SimpleCsvComparatorService::addEpsilonRow().

◆ addRowForComparing()

bool Arcane::SimpleTableInternalComparator::addRowForComparing ( const String row_name)
overridevirtual

Méthode permettant d'ajouter une ligne dans la liste des lignes à comparer.

Paramètres
row_nameLe nom de la ligne à comparer.
Renvoie
true Si le nom a bien été ajouté.
false Sinon.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 166 du fichier SimpleTableInternalComparator.cc.

Références Arccore::Array< T >::add().

Référencé par Arcane::SimpleCsvComparatorService::addRowForComparing().

◆ clearComparator()

void Arcane::SimpleTableInternalComparator::clearComparator ( )
overridevirtual

Méthode permettant de vider les tableaux de comparaison et les expressions régulières. Ne touche pas aux STI.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 144 du fichier SimpleTableInternalComparator.cc.

Références Arccore::Array< T >::clear().

Référencé par Arcane::SimpleCsvComparatorService::clear().

◆ compare()

bool Arcane::SimpleTableInternalComparator::compare ( bool  compare_dimension_too)
overridevirtual

◆ compareElem() [1/2]

bool Arcane::SimpleTableInternalComparator::compareElem ( const String column_name,
const String row_name 
)
overridevirtual

Méthode permettant de comparer uniquement un élement. Les deux SimpleTableInternal sont représentés par des Ref, donc toujours à jour. Cette méthode peut être utilisé pendant le calcul, permettant de comparer les valeurs au fur et à mesure de l'avancement du calcul, au lieu de faire une comparaison final à la fin (il est tout de même possible de faire les deux).

Paramètres
column_nameLe nom de la colonne où se trouve l'élément.
row_nameLe nom de la ligne où se trouve l'élément.
Renvoie
true Si les deux valeurs sont égales.
false Si les deux valeurs sont différentes.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 105 du fichier SimpleTableInternalComparator.cc.

Références Arcane::SimpleTableInternalMng::columnPosition(), compareElem(), Arcane::SimpleTableInternalMng::element(), et Arcane::SimpleTableInternalMng::rowPosition().

Référencé par compareElem(), Arcane::SimpleCsvComparatorService::compareElemWithReference(), et Arcane::SimpleCsvComparatorService::compareElemWithReference().

◆ compareElem() [2/2]

bool Arcane::SimpleTableInternalComparator::compareElem ( Real  elem,
const String column_name,
const String row_name 
)
overridevirtual

Méthode permettant de comparer une valeur avec une valeur du tableau de référence. Cette méthode n'utilise pas l'internal 'toCompare'.

Paramètres
elemLa valeur à comparer.
column_nameLe nom de la colonne où se trouve l'élément de référence.
row_nameLe nom de la ligne où se trouve l'élément de référence.
Renvoie
true Si les deux valeurs sont égales.
false Si les deux valeurs sont différentes.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 116 du fichier SimpleTableInternalComparator.cc.

Références Arcane::SimpleTableInternalMng::columnPosition(), Arcane::SimpleTableInternalMng::element(), Arcane::math::isNearlyEqual(), Arcane::math::isNearlyEqualWithEpsilon(), Arcane::math::max(), et Arcane::SimpleTableInternalMng::rowPosition().

◆ editRegexColumns()

void Arcane::SimpleTableInternalComparator::editRegexColumns ( const String regex_column)
overridevirtual

Méthode permettant d'ajouter une expression régulière permettant de déterminer les colonnes à comparer.

Paramètres
regex_columnL'expression régulière (format ECMAScript).

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 184 du fichier SimpleTableInternalComparator.cc.

Référencé par Arcane::SimpleCsvComparatorService::editRegexColumns().

◆ editRegexRows()

void Arcane::SimpleTableInternalComparator::editRegexRows ( const String regex_row)
overridevirtual

Méthode permettant d'ajouter une expression régulière permettant de déterminer les lignes à comparer.

Paramètres
regex_rowL'expression régulière (format ECMAScript).

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 189 du fichier SimpleTableInternalComparator.cc.

Référencé par Arcane::SimpleCsvComparatorService::editRegexRows().

◆ internalRef()

Ref< SimpleTableInternal > Arcane::SimpleTableInternalComparator::internalRef ( )
overridevirtual

Méthode permettant de récupérer une référence vers l'objet SimpleTableInternal "de référence" utilisé.

Renvoie
Ref<SimpleTableInternal> Une copie de la référence.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 226 du fichier SimpleTableInternalComparator.cc.

◆ internalToCompare()

Ref< SimpleTableInternal > Arcane::SimpleTableInternalComparator::internalToCompare ( )
overridevirtual

Méthode permettant de récupérer une référence vers l'objet SimpleTableInternal "à comparer" utilisé.

Renvoie
Ref<SimpleTableInternal> Une copie de la référence.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 241 du fichier SimpleTableInternalComparator.cc.

◆ isAnArrayExclusiveColumns()

void Arcane::SimpleTableInternalComparator::isAnArrayExclusiveColumns ( bool  is_exclusive)
overridevirtual

Méthode permettant de définir si le tableau de colonnes représente les colonnes à inclure dans la comparaison (false/par défaut) ou représente les colonnes à exclure de la comparaison (true).

Paramètres
is_exclusivetrue si les colonnes doivent être exclus.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 173 du fichier SimpleTableInternalComparator.cc.

Référencé par Arcane::SimpleCsvComparatorService::isAnArrayExclusiveColumns().

◆ isAnArrayExclusiveRows()

void Arcane::SimpleTableInternalComparator::isAnArrayExclusiveRows ( bool  is_exclusive)
overridevirtual

Méthode permettant de définir si le tableau de lignes représente les lignes à inclure dans la comparaison (false/par défaut) ou représente les lignes à exclure de la comparaison (true).

Paramètres
is_exclusivetrue si les lignes doivent être exclus.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 178 du fichier SimpleTableInternalComparator.cc.

Référencé par Arcane::SimpleCsvComparatorService::isAnArrayExclusiveRows().

◆ isARegexExclusiveColumns()

void Arcane::SimpleTableInternalComparator::isARegexExclusiveColumns ( bool  is_exclusive)
overridevirtual

Méthode permettant de demander à ce que l'expression régulière exclut des colonnes au lieu d'en inclure.

Paramètres
is_exclusiveSi l'expression régulière est excluante.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 195 du fichier SimpleTableInternalComparator.cc.

Référencé par Arcane::SimpleCsvComparatorService::isARegexExclusiveColumns().

◆ isARegexExclusiveRows()

void Arcane::SimpleTableInternalComparator::isARegexExclusiveRows ( bool  is_exclusive)
overridevirtual

Méthode permettant de demander à ce que l'expression régulière exclut des lignes au lieu d'en inclure.

Paramètres
is_exclusiveSi l'expression régulière est excluante.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 200 du fichier SimpleTableInternalComparator.cc.

Référencé par Arcane::SimpleCsvComparatorService::isARegexExclusiveRows().

◆ setInternalRef()

void Arcane::SimpleTableInternalComparator::setInternalRef ( const Ref< SimpleTableInternal > &  simple_table_internal)
overridevirtual

Méthode permettant de définir une référence vers un SimpleTableInternal "de référence".

Paramètres
simple_table_internalLa référence vers un SimpleTableInternal.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 232 du fichier SimpleTableInternalComparator.cc.

Références ARCANE_FATAL, et Arcane::SimpleTableInternalMng::setInternal().

Référencé par Arcane::SimpleCsvComparatorService::init().

◆ setInternalToCompare()

void Arcane::SimpleTableInternalComparator::setInternalToCompare ( const Ref< SimpleTableInternal > &  simple_table_internal)
overridevirtual

Méthode permettant de définir une référence vers SimpleTableInternal "à comparer".

Paramètres
simple_table_internalLa référence vers un SimpleTableInternal.

Implémente Arcane::ISimpleTableInternalComparator.

Définition à la ligne 247 du fichier SimpleTableInternalComparator.cc.

Références ARCANE_FATAL, et Arcane::SimpleTableInternalMng::setInternal().

Référencé par Arcane::SimpleCsvComparatorService::init().

Documentation des données membres

◆ m_columns_to_compare

StringUniqueArray Arcane::SimpleTableInternalComparator::m_columns_to_compare
protected

Définition à la ligne 129 du fichier SimpleTableInternalComparator.h.

◆ m_epsilons_column

std::map<String, Real> Arcane::SimpleTableInternalComparator::m_epsilons_column
protected

Définition à la ligne 132 du fichier SimpleTableInternalComparator.h.

◆ m_epsilons_row

std::map<String, Real> Arcane::SimpleTableInternalComparator::m_epsilons_row
protected

Définition à la ligne 133 du fichier SimpleTableInternalComparator.h.

◆ m_is_excluding_array_columns

bool Arcane::SimpleTableInternalComparator::m_is_excluding_array_columns
protected

Définition à la ligne 130 du fichier SimpleTableInternalComparator.h.

◆ m_is_excluding_array_rows

bool Arcane::SimpleTableInternalComparator::m_is_excluding_array_rows
protected

Définition à la ligne 127 du fichier SimpleTableInternalComparator.h.

◆ m_is_excluding_regex_columns

bool Arcane::SimpleTableInternalComparator::m_is_excluding_regex_columns
protected

Définition à la ligne 124 du fichier SimpleTableInternalComparator.h.

◆ m_is_excluding_regex_rows

bool Arcane::SimpleTableInternalComparator::m_is_excluding_regex_rows
protected

Définition à la ligne 121 du fichier SimpleTableInternalComparator.h.

◆ m_regex_columns

String Arcane::SimpleTableInternalComparator::m_regex_columns
protected

Définition à la ligne 123 du fichier SimpleTableInternalComparator.h.

◆ m_regex_rows

String Arcane::SimpleTableInternalComparator::m_regex_rows
protected

Définition à la ligne 120 du fichier SimpleTableInternalComparator.h.

◆ m_rows_to_compare

StringUniqueArray Arcane::SimpleTableInternalComparator::m_rows_to_compare
protected

Définition à la ligne 126 du fichier SimpleTableInternalComparator.h.

◆ m_simple_table_internal_mng_reference

SimpleTableInternalMng Arcane::SimpleTableInternalComparator::m_simple_table_internal_mng_reference
protected

Définition à la ligne 117 du fichier SimpleTableInternalComparator.h.

◆ m_simple_table_internal_mng_to_compare

SimpleTableInternalMng Arcane::SimpleTableInternalComparator::m_simple_table_internal_mng_to_compare
protected

Définition à la ligne 118 du fichier SimpleTableInternalComparator.h.

◆ m_simple_table_internal_reference

Ref<SimpleTableInternal> Arcane::SimpleTableInternalComparator::m_simple_table_internal_reference
protected

Définition à la ligne 114 du fichier SimpleTableInternalComparator.h.

◆ m_simple_table_internal_to_compare

Ref<SimpleTableInternal> Arcane::SimpleTableInternalComparator::m_simple_table_internal_to_compare
protected

Définition à la ligne 115 du fichier SimpleTableInternalComparator.h.


La documentation de cette classe a été générée à partir des fichiers suivants :