A character string (Nom) in uppercase. More...

#include <Motcle.h>

Inheritance diagram for Motcle:

Collaboration diagram for Motcle:

Public Member Functions
	Motcle ()
	Default constructor. Constructs a Nom and converts it to uppercase.
	Motcle (const Motcle &nom)
	Copy constructor.
Motcle &	operator= (const Motcle &)
	Copy assignment operator. Uses the implementation of the Nom class.
	Motcle (const char *const nom)
	Constructs a Motcle from a character string. Constructs a Nom and converts it to uppercase.
	Motcle (const std::string &nom)
	Motcle (const Nom &)
Motcle &	operator= (const char *const)
	Assignment from a character string. Uses the implementation of the Nom class, then converts to uppercase.
Motcle &	operator= (const Nom &)
Motcle &	operator+= (const char *const)
int	selftest ()
	Self-test of the Motcle class. Performs control assignments.
int	debute_par (const char *const n) const override
int	finit_par (const char *const n) const override
int	find (const char *const n) const override
Public Member Functions inherited from Nom
	Nom ()
	Default constructor. Creates the string "??".
	Nom (int i)
	Constructs a name from an integer. The string created is the decimal representation of the integer.
	Nom (long i)
	Nom (long long i)
	Nom (const char *nom)
	Constructs a name from a character string. The string is copied.
	Nom (const std::string &nom)
	Nom (const Nom &)
	Copy constructor for a name.
	Nom (char c)
	Constructs a name from a single character.
	Nom (double)
	Constructs a name from a floating-point number. The string created is the decimal representation of the real number (snprintf).
	Nom (double le_reel, const char *format)
	Constructs a name from a floating-point number with a custom format. The string created is the decimal representation of the real number (snprintf).
	~Nom () override
	Destructor.
	operator const char * () const
	Returns a pointer to the character string of the name.
Nom &	majuscule ()
	Converts the name to uppercase. Only letters 'a'-'z' are modified.
int	est_egal_a (const Objet_U &) const override
	Comparison with an Objet_U. The Objet_U is cast to Nom for the comparison.
int	longueur () const
	Returns the number of characters in the Nom string, including the null terminator.
const Nom &	le_nom () const override
	Returns *this.
Nom &	operator= (const char *const)
	Copies the string nom.
Nom &	operator= (const Nom &)
	Copies the Nom nom.
Nom	operator+ (const Nom &) const
	Concatenation with a Nom.
Nom &	operator+= (const Nom &x)
	Concatenation with a Nom.
Nom &	operator+= (const char *)
Nom &	operator+= (char x)
	String concatenation.
Nom &	operator+= (unsigned char x)
Nom &	operator+= (int x)
Nom &	suffix (const char *const)
	Suffix extraction: Nom x("azerty");.
const Nom	getSuffix (const char *const) const
Nom &	prefix (const char *const)
const Nom	getPrefix (const char *const) const
Nom	nom_me (int, const char *prefix=0, int without_padding=0) const
	Inserts _prefix000n (n=me() or nproc()) into a file name (e.g. toto.titi) to produce toto_prefix000n.titi.
Nom	substr_old (const int, const int) const
	Returns a name using the usual substr command. NOTE: deb = 1 means the first character of the string.
Nom	basename () const
	Returns the filename part if the name is in the form /toto/titi/filename.
int	find (const std::string &n) const
int	debute_par (const std::string &) const
int	finit_par (const std::string &) const
bool	contient (const Nom &nom) const
const char *	getChar () const
const std::string &	getString () const
std::string &	getString ()
Public Member Functions inherited from Objet_U
	~Objet_U () override
	Destructor. Removes the object from the list of objects registered in "memory".
int	numero () const
	Returns the index of the object in Memoire::data.
virtual int	duplique () const =0
virtual Sortie &	printOn (Sortie &) const
	Writes the object to an output stream. Virtual method to override.
virtual Entree &	readOn (Entree &)
	Reads an Objet_U from an input stream. Virtual method to override.
virtual unsigned	taille_memoire () const =0
virtual void	nommer (const Nom &)
	Assigns a name to the Objet_U. Virtual method to override.
virtual int	reprendre (Entree &)
	Restores an Objet_U from an input stream. Virtual method to override.
virtual int	sauvegarder (Sortie &) const
	Saves an Objet_U to an output stream. Virtual method to override.
int	get_object_id () const
	Returns the unique identifier of the object (object_id_).
virtual const Type_info *	get_info () const
	Returns type information for the Objet_U.
const Nom &	que_suis_je () const
	Returns the string identifying the class.
const char *	le_type () const
	Returns the type name of the Objet_U.
virtual int	change_num (const int *const)
	Changes the internal number of the Objet_U.
virtual int	lire_motcle_non_standard (const Motcle &motlu, Entree &is)
	Reads non-simple-type parameters of an Objet_U from an input stream.
virtual int	associer_ (Objet_U &)
	Associates the Objet_U with another Objet_U. Virtual method to override.
const Interprete &	interprete () const
Interprete &	interprete ()
Public Member Functions inherited from Process
virtual	~Process ()

Friends
int	operator== (const Motcle &nom, const Motcle &un_mot)
	Compares a keyword with another keyword (case-insensitive).
int	operator!= (const Motcle &nom, const Motcle &un_mot)
	Compares a keyword with another keyword for inequality (case-insensitive).
int	operator== (const Motcle &un_mot, const char *const nom)
int	operator!= (const Motcle &un_mot, const char *const nom)
int	operator== (const char *const nom, const Motcle &un_mot)
int	operator!= (const char *const nom, const Motcle &un_mot)
int	operator== (const Motcle &un_mot, const Nom &nom)
int	operator!= (const Motcle &un_mot, const Nom &nom)
int	operator== (const Nom &nom, const Motcle &un_mot)
int	operator!= (const Nom &nom, const Motcle &un_mot)

Additional Inherited Members
Static Public Member Functions inherited from Objet_U
static const Nom &	nom_du_cas ()
	Returns a constant reference to the case name. This method is static.
static Nom &	get_set_nom_du_cas ()
	Returns a non-constant reference to the case name (to allow modification). This method is static.
static const Type_info *	info ()
	Returns type information for the Objet_U (static version).
static const Objet_U &	self_cast (const Objet_U &)
	Method added for casting in Python.
static Objet_U &	self_cast (Objet_U &)
Static Public Member Functions inherited from Process
static int	me ()
	Returns the rank of the local processor in the current communication group. See Comm_Group::rank() and PE_Groups::current_group().
static int	nproc ()
	Returns the number of processors in the current group. See Comm_Group::nproc() and PE_Groups::current_group().
static bool	is_parallel ()
static void	exit (int exit_code=-1)
	Exit routine for TRUST within a Kokkos region.
static double	mp_sum (double)
	Computes the sum of x over all processors in the current group.
static float	mp_sum (float)
static trustIdType	mp_sum (trustIdType)
	Computes the sum of x over all processors in the current group.
static double	mp_max (double)
static double	mp_min (double)
static int	mp_max (int)
	Returns the maximum value of x across all processors in the current group.
static int	mp_min (int)
	Returns the minimum value of x across all processors in the current group.
static double	mp_sum_as_double (int v)
static trustIdType	mppartial_sum (trustIdType i)
	Computes the partial sum of x over processors 0 to me()-1 (returns 0 on processor 0).
template<typename T>
static void	mp_sum_for_each (T &arg1, T &arg2)
	C++14 compatible mp_sum_for_each: combine multiple mp_sum calls into one collective operation Usage: mp_sum_for_each(a, b); mp_sum_for_each(a, b, c); mp_sum_for_each(a, b, c, d); mp_sum_for_each(a, b, c, d, e); All arguments must be of the same type (double or int) and are modified in place. Supports 2-5 parameters.
template<typename T>
static void	mp_sum_for_each (T &arg1, T &arg2, T &arg3)
template<typename T>
static void	mp_sum_for_each (T &arg1, T &arg2, T &arg3, T &arg4)
template<typename T>
static void	mp_sum_for_each (T &arg1, T &arg2, T &arg3, T &arg4, T &arg5)
template<typename T>
static void	mp_max_for_each (T &arg1, T &arg2)
	C++14 compatible mp_max_for_each: combine multiple mp_max calls into one collective operation.
template<typename T>
static void	mp_max_for_each (T &arg1, T &arg2, T &arg3)
template<typename T>
static void	mp_max_for_each (T &arg1, T &arg2, T &arg3, T &arg4)
template<typename T>
static void	mp_max_for_each (T &arg1, T &arg2, T &arg3, T &arg4, T &arg5)
template<typename T>
static void	mp_min_for_each (T &arg1, T &arg2)
	C++14 compatible mp_min_for_each: combine multiple mp_min calls into one collective operation.
template<typename T>
static void	mp_min_for_each (T &arg1, T &arg2, T &arg3)
template<typename T>
static void	mp_min_for_each (T &arg1, T &arg2, T &arg3, T &arg4)
template<typename T>
static void	mp_min_for_each (T &arg1, T &arg2, T &arg3, T &arg4, T &arg5)
template<typename _TYPE_>
static void	mp_sum_for_each_item (TRUSTArray< _TYPE_ > &x, int n=-1)
template<typename _TYPE_>
static void	mp_max_for_each_item (TRUSTArray< _TYPE_ > &x, int n=-1)
template<typename _TYPE_>
static void	mp_min_for_each_item (TRUSTArray< _TYPE_ > &x, int n=-1)
static bool	mp_and (bool)
	Computes the logical AND of b across all processors in the current group.
static bool	mp_or (bool)
static int	check_int_overflow (trustIdType)
static int	je_suis_maitre ()
	Returns 1 if on the master processor of the current group (i.e. me() == 0), 0 otherwise.
static KOKKOS_INLINE_FUNCTION void	Kokkos_exit (const char *)
	Exit routine for TRUST within a Kokkos region.
static int	node_master ()
	Returns 1 if on the NUMA node master processor, 0 otherwise.
static void	exit (const Nom &message, int exit_code=-1)
static bool	is_sequential ()
static void	barrier ()
	Synchronizes all processors in the current group (waits until all processors have reached the barrier).
static void	abort ()
	Abort routine for TRUST on a fatal error.
static Sortie &	Journal (int message_level=0)
	Returns a static Sortie object used as an event journal.
static double	ram_processeur ()
static void	imprimer_ram_totale (int all_process=0)
static bool	force_single_file (const int ranks, const Nom &filename)
Static Public Attributes inherited from Objet_U
static double	precision_geom = 1e-10
static constexpr bool	HAS_POINTER = false
static int	dimension =0
static int	format_precision_geom =11
static int	axi =0
static int	bidim_axi =0
static int	DEACTIVATE_SIGINT_CATCH =0
static Type_info	info_obj
static bool	disable_TU =false
	Flag to disable or not the writing of the .TU files.
static bool	stat_per_proc_perf_log =false
	Flag to enable the writing of the statistics detailed per processor in _csv.TU file.
Static Public Attributes inherited from Process
static int	exception_sur_exit =0
static int	multiple_files =5120
Protected Member Functions inherited from Objet_U
	Objet_U ()
	Default constructor: assigns a unique identifier to the object (object_id_) and registers the object in "memory" by giving it a num_obj number.
	Objet_U (const Objet_U &)
	Copy constructor.
const Objet_U &	operator= (const Objet_U &)
	Assignment operator: does nothing (the number and identifier are preserved).
virtual void	set_param (Param &) const
Protected Attributes inherited from Nom
std::string	nom_

Detailed Description

A character string (Nom) in uppercase.

Definition at line 25 of file Motcle.h.

Constructor & Destructor Documentation

◆ Motcle() [1/5]

Motcle::Motcle ( )

Default constructor. Constructs a Nom and converts it to uppercase.

Definition at line 61 of file Motcle.cpp.

◆ Motcle() [2/5]

Motcle::Motcle ( const Motcle & nom )

Copy constructor.

Parameters

nom	The Motcle to copy.

Definition at line 90 of file Motcle.cpp.

◆ Motcle() [3/5]

Motcle::Motcle ( const char *const nom )

Constructs a Motcle from a character string. Constructs a Nom and converts it to uppercase.

Parameters

nom	The character string for the Motcle.

Definition at line 71 of file Motcle.cpp.

◆ Motcle() [4/5]

Motcle::Motcle ( const std::string & nom )

Definition at line 76 of file Motcle.cpp.

◆ Motcle() [5/5]

Motcle::Motcle ( const Nom & nom )

Definition at line 81 of file Motcle.cpp.

Member Function Documentation

◆ debute_par()

int Motcle::debute_par ( const char *const n ) const

overridevirtual

Reimplemented from Nom.

Definition at line 307 of file Motcle.cpp.

◆ find()

int Motcle::find ( const char *const n ) const

overridevirtual

Reimplemented from Nom.

Definition at line 313 of file Motcle.cpp.

◆ finit_par()

int Motcle::finit_par ( const char *const n ) const

overridevirtual

Reimplemented from Nom.

Definition at line 300 of file Motcle.cpp.

◆ operator+=()

Motcle & Motcle::operator+= ( const char * const mot )

Definition at line 283 of file Motcle.cpp.

◆ operator=() [1/3]

Motcle & Motcle::operator= ( const char * const mot )

Assignment from a character string. Uses the implementation of the Nom class, then converts to uppercase.

Parameters

mot	The character string to assign.

Returns: Reference to the modified Motcle.

Definition at line 99 of file Motcle.cpp.

◆ operator=() [2/3]

Motcle & Motcle::operator= ( const Motcle & mot )

Copy assignment operator. Uses the implementation of the Nom class.

Parameters

mot	The Motcle to copy.

Returns: Reference to the modified Motcle.

Definition at line 118 of file Motcle.cpp.

◆ operator=() [3/3]

Motcle & Motcle::operator= ( const Nom & mot )

Definition at line 106 of file Motcle.cpp.

◆ selftest()

int Motcle::selftest ( )

Self-test of the Motcle class. Performs control assignments.

Always returns 1.

Returns: Always 1.

Definition at line 141 of file Motcle.cpp.

◆ operator!= [1/5]

int operator!=	(	const char * const	nom,
		const Motcle &	un_mot )

friend

Definition at line 268 of file Motcle.cpp.

◆ operator!= [2/5]

int operator!=	(	const Motcle &	nom,
		const Motcle &	un_mot )

friend

Compares a keyword with another keyword for inequality (case-insensitive).

Parameters

nom	The first Motcle.
un_mot	The second Motcle.

Returns: 1 if the names differ, 0 otherwise.

Definition at line 258 of file Motcle.cpp.

◆ operator!= [3/5]

int operator!=	(	const Motcle &	un_mot,
		const char * const	nom )

friend

Definition at line 263 of file Motcle.cpp.

◆ operator!= [4/5]

int operator!=	(	const Motcle &	un_mot,
		const Nom &	nom )

friend

Definition at line 273 of file Motcle.cpp.

◆ operator!= [5/5]

int operator!=	(	const Nom &	nom,
		const Motcle &	un_mot )

friend

Definition at line 278 of file Motcle.cpp.

◆ operator== [1/5]

int operator==	(	const char * const	nom,
		const Motcle &	un_mot )

friend

Definition at line 236 of file Motcle.cpp.

◆ operator== [2/5]

int operator==	(	const Motcle &	nom,
		const Motcle &	un_mot )

friend

Compares a keyword with another keyword (case-insensitive).

Parameters

nom	The first Motcle.
un_mot	The second Motcle.

Returns: 1 if the names are equal, 0 otherwise.

Definition at line 224 of file Motcle.cpp.

◆ operator== [3/5]

int operator==	(	const Motcle &	un_mot,
		const char * const	nom )

friend

Definition at line 230 of file Motcle.cpp.

◆ operator== [4/5]

int operator==	(	const Motcle &	un_mot,
		const Nom &	nom )

friend

Definition at line 241 of file Motcle.cpp.

◆ operator== [5/5]

int operator==	(	const Nom &	nom,
		const Motcle &	un_mot )

friend

Definition at line 247 of file Motcle.cpp.

The documentation for this class was generated from the following files:

/home/docs/trust-code/src/Kernel/Utilitaires/Motcle.h
/home/docs/trust-code/src/Kernel/Utilitaires/Motcle.cpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Motcle() [1/5]

◆ Motcle() [2/5]

◆ Motcle() [3/5]

◆ Motcle() [4/5]

◆ Motcle() [5/5]

Member Function Documentation

◆ debute_par()

◆ find()

◆ finit_par()

◆ operator+=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ selftest()

Friends And Related Symbol Documentation

◆ operator!= [1/5]

◆ operator!= [2/5]

◆ operator!= [3/5]

◆ operator!= [4/5]

◆ operator!= [5/5]

◆ operator== [1/5]

◆ operator== [2/5]

◆ operator== [3/5]

◆ operator== [4/5]

◆ operator== [5/5]