Interface de classe représentant un comparateur de SimpleTableInternal (aka STI). Plus de détails...

#include <arcane/core/ISimpleTableInternalComparator.h>

Graphe d'héritage de Arcane::ISimpleTableInternalComparator:

Graphe de collaboration de Arcane::ISimpleTableInternalComparator:

Fonctions membres publiques
virtual bool	compare (bool compare_dimension_too=false)=0
	Méthode permettant de comparer les valeurs des deux STI.

virtual bool	compareElem (const String &column_name, const String &row_name)=0
	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).

virtual bool	compareElem (Real elem, const String &column_name, const String &row_name)=0
	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'.

virtual void	clearComparator ()=0
	Méthode permettant de vider les tableaux de comparaison et les expressions régulières. Ne touche pas aux STI.

virtual bool	addColumnForComparing (const String &column_name)=0
	Méthode permettant d'ajouter une colonne dans la liste des colonnes à comparer.

virtual bool	addRowForComparing (const String &row_name)=0
	Méthode permettant d'ajouter une ligne dans la liste des lignes à comparer.

virtual void	isAnArrayExclusiveColumns (bool is_exclusive)=0
	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).

virtual void	isAnArrayExclusiveRows (bool is_exclusive)=0
	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).

virtual void	editRegexColumns (const String &regex_column)=0
	Méthode permettant d'ajouter une expression régulière permettant de déterminer les colonnes à comparer.

virtual void	editRegexRows (const String &regex_row)=0
	Méthode permettant d'ajouter une expression régulière permettant de déterminer les lignes à comparer.

virtual void	isARegexExclusiveColumns (bool is_exclusive)=0
	Méthode permettant de demander à ce que l'expression régulière exclut des colonnes au lieu d'en inclure.

virtual void	isARegexExclusiveRows (bool is_exclusive)=0
	Méthode permettant de demander à ce que l'expression régulière exclut des lignes au lieu d'en inclure.

virtual bool	addEpsilonColumn (const String &column_name, Real epsilon)=0
	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.

virtual bool	addEpsilonRow (const String &row_name, Real epsilon)=0
	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.

virtual Ref< SimpleTableInternal >	internalRef ()=0
	Méthode permettant de récupérer une référence vers l'objet SimpleTableInternal "de référence" utilisé.

virtual void	setInternalRef (const Ref< SimpleTableInternal > &simple_table_internal)=0
	Méthode permettant de définir une référence vers un SimpleTableInternal "de référence".

virtual Ref< SimpleTableInternal >	internalToCompare ()=0
	Méthode permettant de récupérer une référence vers l'objet SimpleTableInternal "à comparer" utilisé.

virtual void	setInternalToCompare (const Ref< SimpleTableInternal > &simple_table_internal)=0
	Méthode permettant de définir une référence vers SimpleTableInternal "à comparer".

Description détaillée

Interface de classe représentant un comparateur de SimpleTableInternal (aka STI).

Le principe est de comparer les valeurs d'un STI avec les valeurs d'un STI de référence, en utilisant un epsilon représentant la marge d'erreur acceptable.

Il existe deux types de manières de configurer ce comparateur :

deux tableaux de String (ligne/colonne),
deux expressions régulières (ligne/colonne).

On peut ajouter des noms de lignes/colonnes dans ces tableaux, préciser si ce sont des lignes/colonnes à inclure dans la comparaison au, au contraire, si ces lignes/colonnes sont à exclure de la comparaison.

Idem pour les expressions régulières, on ajoute une expression régulière lignes/colonnes et on précise si ce sont des expressions incluant ou excluant des lignes/colonnes.

Si les deux types de manières sont définis, les tableaux priment sur les expressions régulières : d'abord on regarde la présence du nom de la ligne/colonne dans le tableau correspondant.

Si le nom est présent, on inclut/exclut cette ligne/colonne de la comparaison. Si le nom est absent mais qu'il y a une expression régulière de défini, on recherche une correspondance dedans.

Si aucun des types ne sont défini (tableau vide et expression régulière vide), on inclut toutes les lignes/colonnes dans la comparaison.

Définition à la ligne 68 du fichier ISimpleTableInternalComparator.h.

Documentation des fonctions membres

◆ addColumnForComparing()

virtual bool Arcane::ISimpleTableInternalComparator::addColumnForComparing ( const String & column_name )

pure virtual

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

Paramètres

column_name Le nom de la colonne à comparer.

Renvoie: true Si le nom a bien été ajouté.; false Sinon.

Implémenté dans Arcane::SimpleTableInternalComparator.

◆ addEpsilonColumn()

virtual bool Arcane::ISimpleTableInternalComparator::addEpsilonColumn	(	const String &	column_name,
		Real	epsilon
	)

pure virtual

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_name	Le nom de la colonne où l'epsilon sera pris en compte.
epsilon	La 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émenté dans Arcane::SimpleTableInternalComparator.

◆ addEpsilonRow()

virtual bool Arcane::ISimpleTableInternalComparator::addEpsilonRow	(	const String &	row_name,
		Real	epsilon
	)

pure virtual

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_name	Le nom de la ligne où l'epsilon sera pris en compte.
epsilon	La 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émenté dans Arcane::SimpleTableInternalComparator.

◆ addRowForComparing()

virtual bool Arcane::ISimpleTableInternalComparator::addRowForComparing ( const String & row_name )

pure virtual

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

Paramètres

row_name Le nom de la ligne à comparer.

Renvoie: true Si le nom a bien été ajouté.; false Sinon.

Implémenté dans Arcane::SimpleTableInternalComparator.

◆ clearComparator()

virtual void Arcane::ISimpleTableInternalComparator::clearComparator ( )

pure virtual

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

Implémenté dans Arcane::SimpleTableInternalComparator.

◆ compare()

virtual bool Arcane::ISimpleTableInternalComparator::compare ( bool compare_dimension_too = false )

pure virtual

Méthode permettant de comparer les valeurs des deux STI.

Paramètres

compare_dimension_too Si l'on doit comparer les dimensions des STI.

Renvoie: true S'il n'y a pas de différences.; false S'il y a au moins une différence.

Implémenté dans Arcane::SimpleTableInternalComparator.

◆ compareElem() [1/2]

virtual bool Arcane::ISimpleTableInternalComparator::compareElem	(	const String &	column_name,
		const String &	row_name
	)

pure virtual

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_name	Le nom de la colonne où se trouve l'élément.
row_name	Le 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émenté dans Arcane::SimpleTableInternalComparator.

◆ compareElem() [2/2]

virtual bool Arcane::ISimpleTableInternalComparator::compareElem	(	Real	elem,
		const String &	column_name,
		const String &	row_name
	)

pure virtual

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

elem	La valeur à comparer.
column_name	Le nom de la colonne où se trouve l'élément de référence.
row_name	Le 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émenté dans Arcane::SimpleTableInternalComparator.

◆ editRegexColumns()

virtual void Arcane::ISimpleTableInternalComparator::editRegexColumns ( const String & regex_column )

pure virtual

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

Paramètres

regex_column L'expression régulière (format ECMAScript).

Implémenté dans Arcane::SimpleTableInternalComparator.

◆ editRegexRows()

virtual void Arcane::ISimpleTableInternalComparator::editRegexRows ( const String & regex_row )

pure virtual

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

Paramètres

regex_row L'expression régulière (format ECMAScript).

Implémenté dans Arcane::SimpleTableInternalComparator.

◆ internalRef()

virtual Ref< SimpleTableInternal > Arcane::ISimpleTableInternalComparator::internalRef ( )

pure virtual

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émenté dans Arcane::SimpleTableInternalComparator.

◆ internalToCompare()

virtual Ref< SimpleTableInternal > Arcane::ISimpleTableInternalComparator::internalToCompare ( )

pure virtual

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émenté dans Arcane::SimpleTableInternalComparator.

◆ isAnArrayExclusiveColumns()

virtual void Arcane::ISimpleTableInternalComparator::isAnArrayExclusiveColumns ( bool is_exclusive )

pure virtual

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_exclusive true si les colonnes doivent être exclus.

Implémenté dans Arcane::SimpleTableInternalComparator.

◆ isAnArrayExclusiveRows()

virtual void Arcane::ISimpleTableInternalComparator::isAnArrayExclusiveRows ( bool is_exclusive )

pure virtual

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_exclusive true si les lignes doivent être exclus.

Implémenté dans Arcane::SimpleTableInternalComparator.

◆ isARegexExclusiveColumns()

virtual void Arcane::ISimpleTableInternalComparator::isARegexExclusiveColumns ( bool is_exclusive )

pure virtual

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

Paramètres

is_exclusive Si l'expression régulière est excluante.

Implémenté dans Arcane::SimpleTableInternalComparator.

◆ isARegexExclusiveRows()

virtual void Arcane::ISimpleTableInternalComparator::isARegexExclusiveRows ( bool is_exclusive )

pure virtual

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

Paramètres

is_exclusive Si l'expression régulière est excluante.

Implémenté dans Arcane::SimpleTableInternalComparator.

◆ setInternalRef()

virtual void Arcane::ISimpleTableInternalComparator::setInternalRef ( const Ref< SimpleTableInternal > & simple_table_internal )

pure virtual

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

Paramètres

simple_table_internal La référence vers un SimpleTableInternal.

Implémenté dans Arcane::SimpleTableInternalComparator.

◆ setInternalToCompare()

virtual void Arcane::ISimpleTableInternalComparator::setInternalToCompare ( const Ref< SimpleTableInternal > & simple_table_internal )

pure virtual

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

Paramètres

simple_table_internal La référence vers un SimpleTableInternal.

Implémenté dans Arcane::SimpleTableInternalComparator.

La documentation de cette classe a été générée à partir du fichier suivant :

ISimpleTableInternalComparator.h

Fonctions membres publiques

Description détaillée

Documentation des fonctions membres

◆ addColumnForComparing()

◆ addEpsilonColumn()

◆ addEpsilonRow()

◆ addRowForComparing()

◆ clearComparator()

◆ compare()

◆ compareElem() [1/2]

◆ compareElem() [2/2]

◆ editRegexColumns()

◆ editRegexRows()

◆ internalRef()

◆ internalToCompare()

◆ isAnArrayExclusiveColumns()

◆ isAnArrayExclusiveRows()

◆ isARegexExclusiveColumns()

◆ isARegexExclusiveRows()

◆ setInternalRef()

◆ setInternalToCompare()