Arcane  4.2.1.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
Référence du fichier ArccoreGlobal.h

Définitions et globaux de Arccore. Plus de détails...

#include <cstdint>
#include "arccore/arccore_config.h"
Graphe des dépendances par inclusion de ArccoreGlobal.h:
Ce graphe montre quels fichiers incluent directement ou indirectement ce fichier :

Aller au code source de ce fichier.

Classes

class  Arcane::APReal
 Emulation de réel en précision arbitraire. Plus de détails...
struct  Arcane::TrueType
struct  Arcane::FalseType
class  Arccore::ITraceMng
 Interface du gestionnaire de traces. Plus de détails...
class  Arccore::String
 Chaîne de caractères unicode. Plus de détails...
class  Arccore::StringBuilder
 Constructeur de chaîne de caractère unicode. Plus de détails...
class  Arccore::StringFormatterArg
class  Arccore::StringView
 Vue sur une chaîne de caractères UTF-8. Plus de détails...
class  Arccore::APReal
 Emulation de réel en précision arbitraire. Plus de détails...
struct  Arccore::FalseType
struct  Arccore::TrueType

Espaces de nommage

namespace  Arcane
 -- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
namespace  Arccore
 Espace de nom de Arccore.

Macros

#define ARCCORE_EXPORT   __attribute__((visibility("default")))
#define ARCCORE_IMPORT   __attribute__((visibility("default")))
#define ARCCORE_TEMPLATE_EXPORT   ARCCORE_EXPORT
#define ARCCORE_RESTRICT
#define ARCCORE_STD   std
#define ARCCORE_UNUSED(var)
#define ARCCORE_DEVICE
#define ARCCORE_BASE_EXPORT   ARCCORE_IMPORT
#define ARCCORE_BASE_EXTERN_TPL   extern
#define ARCCORE_REAL(val)
#define ARCCORE_REAL_IS_DOUBLE
#define ARCCORE_INTEGER_MAX   ARCCORE_INT32_MAX
 Macro indiquant la valeur maximal que peut prendre le type #Integer.
#define ARCCORE_DEPRECATED_2017   ARCCORE_DEPRECATED
#define ARCCORE_DEPRECATED_2018   ARCCORE_DEPRECATED
#define ARCCORE_DEPRECATED_2019(reason)
#define ARCCORE_DEPRECATED_2020(reason)
#define ARCCORE_DEPRECATED_REASON(reason)
#define ARCCORE_NO_DEPRECATED
#define ARCCORE_DEPRECATED
#define ARCCORE_NORETURN   [[noreturn]]
#define ARCCORE_CONSTEXPR   constexpr
 Macro permettant de spécifier le mot-clé 'constexpr' du C++11.
#define ARCCORE_NOEXCEPT   noexcept
#define ARCCORE_NOEXCEPT_FALSE   noexcept(false)
#define ARCCORE_NO_UNIQUE_ADDRESS   [[no_unique_address]]
#define ARCCORE_ALIGNAS_PACKED(value)
 Macro pour garantir le compactage et l'alignement d'une classe sur value octets.
#define ARCCORE_ALIGNAS(value)
 Macro pour garantir l'alignement d'une classe sur value octets.
#define ARCCORE_THROW(exception_class, ...)
 Macro pour envoyer une exception avec formattage.
#define ARCCORE_THROW_IF(cond, exception_class, ...)
 Macro pour envoyer une exception avec formattage si cond est vrai.
#define ARCCORE_FATAL(...)
 Macro envoyant une exception FatalErrorException.
#define ARCCORE_FATAL_IF(cond, ...)
 Macro envoyant une exception FatalErrorException si cond est vrai.
#define ARCCORE_CHECK_AT(a, b)
#define ARCCORE_CHECK_RANGE(a, b, c)
#define ARCCORE_CHECK_AT2(a0, a1, b0, b1)
#define ARCCORE_CHECK_AT3(a0, a1, a2, b0, b1, b2)
#define ARCCORE_CHECK_AT4(a0, a1, a2, a3, b0, b1, b2, b3)
#define ARCCORE_CAST_SMALL_SIZE(a)
#define ARCCORE_MACRO_FUNCTION_NAME   __func__
#define ARCCORE_CHECK_PTR(a)
#define ARCCORE_ASSERT(a, b)
#define ARCCORE_WARNING(a)
#define ARCCORE_DCHECK_POINTER(a)
#define ARCCORE_CHECK_POINTER(ptr)
 Macro retournant le pointeur ptr s'il est non nul ou lancant une exception s'il est nul.
#define ARCCORE_CHECK_POINTER2(ptr, text)
 Macro retournant le pointeur ptr s'il est non nul ou lancant une exception s'il est nul.
#define ARCCORE_JOIN_HELPER2(a, b)
#define ARCCORE_JOIN_HELPER(a, b)
#define ARCCORE_JOIN_WITH_LINE(a)

Définitions de type

typedef ARCCORE_TYPE_INT16 Int16
typedef ARCCORE_TYPE_INT32 Int32
typedef ARCCORE_TYPE_INT64 Int64
using Arcane::Int8 = std::int8_t
 Type entier signé sur 8 bits.
using Arcane::Int16 = std::int16_t
 Type entier signé sur 16 bits.
using Arcane::Int32 = std::int32_t
 Type entier signé sur 32 bits.
using Arcane::Int64 = std::int64_t
 Type entier signé sur 64 bits.
using Arcane::UInt32 = std::uint32_t
 Type entier non signé sur 32 bits.
using Arcane::UInt64 = std::uint64_t
 Type entier non signé sur 64 bits.
using Arcane::Pointer = void*
 Type représentant un pointeur.
using Arcane::Real = double
 Type représentant un réel.
using Arcane::Short = Int32
using Arcane::Integer = Int32
 Type représentant un entier.
using Arcane::Float32 = float
 Type flottant IEEE-753 simple précision.
using Arccore::BFloat16 = Arcane::BFloat16
 Type 'Brain Float16'.
using Arccore::Float16 = Arcane::Float16
 Type 'Float16' (binary16).
using Arccore::Float32 = float
 Type flottant IEEE-753 simple précision (binary32).
using Arccore::Int8 = Arcane::Int8
 Type représentant un entier sur 8 bits.
using Arccore::Float128 = Arcane::Float128
 Type représentant un floattan sur 128 bits.
using Arccore::Int128 = Arcane::Int128
 Type représentant un entier sur 128 bits.
using Arccore::Int16 = Arcane::Int16
using Arccore::Int32 = Arcane::Int32
using Arccore::Int64 = Arcane::Int64
using Arccore::UInt32
 Type entier non signé sur 32 bits.
using Arccore::UInt64
 Type entier non signé sur 64 bits.
using Arccore::Integer
 Type représentant un entier.
using Arccore::Pointer
 Type représentant un pointeur.
using Arccore::Real
 Type représentant un réel.
using Arccore::Short

Fonctions

bool Arcane::arccoreIsCheck ()
 Vrai si on est en mode vérification.
void Arcane::arccoreSetCheck (bool v)
 Active ou désactive le mode vérification.
bool Arcane::arccoreIsDebug ()
 Vrai si la macro ARCCORE_DEBUG est définie.
void Arcane::arccorePrintf (const char *,...)
 Encapsulation de la fonction C printf.
void Arcane::arccoreDebugPause (const char *msg)
 Passe en mode pause ou lance une erreur fatale.
void Arcane::arccoreSetPauseOnError (bool v)
 Indique si on l'appel à arccoreDebugPause() effectue une pause.
void Arcane::arccoreNullPointerError ()
 Signalue l'utilisation d'un pointeur nul.
void Arcane::arccoreRangeError (Int64 i, Int64 min_value_inclusive, Int64 max_value_exclusive)
 Signale qu'une valeur n'est pas dans l'intervalle souhaité.
void Arcane::arccoreRangeError (Int64 i, Int64 max_size)
 Signale qu'une valeur n'est pas dans l'intervalle souhaité.
__host__ __device__ void Arcane::arccoreCheckRange (Int64 i, Int64 min_value_inclusive, Int64 max_value_exclusive)
 Vérifie que min_value_inclusive <= i < max_value_exclusive.
__host__ __device__ void Arcane::arccoreCheckAt (Int64 i, Int64 max_size)
 Vérifie un éventuel débordement de tableau.
void Arcane::_doAssert (const char *text, const char *file, const char *func, int line)
template<typename T>
T * Arcane::_checkPointer (const T *t, const char *file, const char *func, int line)
void Arcane::arccoreThrowNullPointerError (const char *ptr_name, const char *text)
 Signalee l'utilisation d'un pointeur nul en envoyant une exception.
void * Arcane::arccoreThrowIfNull (void *ptr, const char *ptr_name, const char *text)
 Vérifie qu'un pointeur n'est pas nul.
const void * Arcane::arccoreThrowIfNull (const void *ptr, const char *ptr_name, const char *text)
 Vérifie qu'un pointeur n'est pas nul.
__host__ __device__ void Arccore::arccoreCheckAt (Int64 i, Int64 max_size)
 Vérifie un éventuel débordement de tableau.
__host__ __device__ void Arccore::arccoreCheckRange (Int64 i, Int64 min_value_inclusive, Int64 max_value_exclusive)
 Vérifie que min_value_inclusive <= i < max_value_exclusive.
void Arccore::arccoreDebugPause (const char *msg)
 Passe en mode pause ou lance une erreur fatale.
bool Arccore::arccoreIsCheck ()
 Vrai si on est en mode vérification.
bool Arccore::arccoreIsDebug ()
 Vrai si la macro ARCCORE_DEBUG est définie.
void Arccore::arccoreNullPointerError ()
 Signalue l'utilisation d'un pointeur nul.
void Arccore::arccorePrintf (const char *,...)
 Encapsulation de la fonction C printf.
void Arccore::arccoreRangeError (Int64 i, Int64 min_value_inclusive, Int64 max_value_exclusive)
 Signale qu'une valeur n'est pas dans l'intervalle souhaité.
void Arccore::arccoreSetCheck (bool v)
 Active ou désactive le mode vérification.
void Arccore::arccoreSetPauseOnError (bool v)
 Indique si on l'appel à arccoreDebugPause() effectue une pause.
void * Arccore::arccoreThrowIfNull (void *ptr, const char *ptr_name, const char *text)
 Vérifie qu'un pointeur n'est pas nul.
void Arccore::arccoreThrowNullPointerError (const char *ptr_name, const char *text)
 Signalee l'utilisation d'un pointeur nul en envoyant une exception.
template<typename T>
T * Arccore::_checkPointer (const T *t, const char *file, const char *func, int line)
void Arccore::_doAssert (const char *text, const char *file, const char *func, size_t line)

Description détaillée

Définitions et globaux de Arccore.

Définition dans le fichier ArccoreGlobal.h.

Documentation des macros

◆ ARCCORE_ALIGNAS

#define ARCCORE_ALIGNAS ( value)
Valeur :
__attribute__((aligned(value)))

Macro pour garantir l'alignement d'une classe sur value octets.

Définition à la ligne 446 du fichier ArccoreGlobal.h.

◆ ARCCORE_ALIGNAS_PACKED

#define ARCCORE_ALIGNAS_PACKED ( value)
Valeur :
__attribute__((aligned(value), packed))

Macro pour garantir le compactage et l'alignement d'une classe sur value octets.

Définition à la ligne 444 du fichier ArccoreGlobal.h.

◆ ARCCORE_ASSERT

#define ARCCORE_ASSERT ( a,
b )

Définition à la ligne 740 du fichier ArccoreGlobal.h.

◆ ARCCORE_BASE_EXPORT

#define ARCCORE_BASE_EXPORT   ARCCORE_IMPORT

Définition à la ligne 208 du fichier ArccoreGlobal.h.

◆ ARCCORE_BASE_EXTERN_TPL

#define ARCCORE_BASE_EXTERN_TPL   extern

Définition à la ligne 209 du fichier ArccoreGlobal.h.

◆ ARCCORE_CAST_SMALL_SIZE

#define ARCCORE_CAST_SMALL_SIZE ( a)
Valeur :
((Integer)(a))

Définition à la ligne 678 du fichier ArccoreGlobal.h.

◆ ARCCORE_CHECK_AT

#define ARCCORE_CHECK_AT ( a,
b )

Définition à la ligne 658 du fichier ArccoreGlobal.h.

◆ ARCCORE_CHECK_AT2

#define ARCCORE_CHECK_AT2 ( a0,
a1,
b0,
b1 )
Valeur :
ARCCORE_CHECK_AT(a0, b0); \
ARCCORE_CHECK_AT(a1, b1)

Définition à la ligne 662 du fichier ArccoreGlobal.h.

◆ ARCCORE_CHECK_AT3

#define ARCCORE_CHECK_AT3 ( a0,
a1,
a2,
b0,
b1,
b2 )
Valeur :
ARCCORE_CHECK_AT(a0, b0); \
ARCCORE_CHECK_AT(a1, b1); \
ARCCORE_CHECK_AT(a2, b2)

Définition à la ligne 665 du fichier ArccoreGlobal.h.

◆ ARCCORE_CHECK_AT4

#define ARCCORE_CHECK_AT4 ( a0,
a1,
a2,
a3,
b0,
b1,
b2,
b3 )
Valeur :
ARCCORE_CHECK_AT(a0, b0); \
ARCCORE_CHECK_AT(a1, b1); \
ARCCORE_CHECK_AT(a2, b2); \
ARCCORE_CHECK_AT(a3, b3)

Définition à la ligne 669 du fichier ArccoreGlobal.h.

◆ ARCCORE_CHECK_POINTER

◆ ARCCORE_CHECK_POINTER2

#define ARCCORE_CHECK_POINTER2 ( ptr,
text )
Valeur :
arccoreThrowIfNull(ptr, #ptr, text)

Macro retournant le pointeur ptr s'il est non nul ou lancant une exception s'il est nul.

Voir également
arccoreThrowIfNull().

Définition à la ligne 811 du fichier ArccoreGlobal.h.

◆ ARCCORE_CHECK_PTR

#define ARCCORE_CHECK_PTR ( a)

Définition à la ligne 739 du fichier ArccoreGlobal.h.

◆ ARCCORE_CHECK_RANGE

#define ARCCORE_CHECK_RANGE ( a,
b,
c )

Définition à la ligne 659 du fichier ArccoreGlobal.h.

◆ ARCCORE_CONSTEXPR

#define ARCCORE_CONSTEXPR   constexpr

Macro permettant de spécifier le mot-clé 'constexpr' du C++11.

Définition à la ligne 401 du fichier ArccoreGlobal.h.

Référencé par Arcane::BasicSerializer::paddingSize().

◆ ARCCORE_DCHECK_POINTER

#define ARCCORE_DCHECK_POINTER ( a)
Valeur :
(a);

Définition à la ligne 742 du fichier ArccoreGlobal.h.

◆ ARCCORE_DEPRECATED

#define ARCCORE_DEPRECATED

Définition à la ligne 383 du fichier ArccoreGlobal.h.

◆ ARCCORE_DEPRECATED_2017

#define ARCCORE_DEPRECATED_2017   ARCCORE_DEPRECATED

Définition à la ligne 369 du fichier ArccoreGlobal.h.

◆ ARCCORE_DEPRECATED_2018

#define ARCCORE_DEPRECATED_2018   ARCCORE_DEPRECATED

Définition à la ligne 370 du fichier ArccoreGlobal.h.

◆ ARCCORE_DEPRECATED_2019

#define ARCCORE_DEPRECATED_2019 ( reason)
Valeur :
[[deprecated(reason)]]

Définition à la ligne 371 du fichier ArccoreGlobal.h.

◆ ARCCORE_DEPRECATED_2020

#define ARCCORE_DEPRECATED_2020 ( reason)
Valeur :
[[deprecated(reason)]]

Définition à la ligne 372 du fichier ArccoreGlobal.h.

◆ ARCCORE_DEPRECATED_REASON

#define ARCCORE_DEPRECATED_REASON ( reason)
Valeur :
[[deprecated(reason)]]

Définition à la ligne 376 du fichier ArccoreGlobal.h.

◆ ARCCORE_DEVICE

#define ARCCORE_DEVICE

Définition à la ligne 153 du fichier ArccoreGlobal.h.

◆ ARCCORE_EXPORT

#define ARCCORE_EXPORT   __attribute__((visibility("default")))

Définition à la ligne 60 du fichier ArccoreGlobal.h.

◆ ARCCORE_FATAL

#define ARCCORE_FATAL ( ...)
Valeur :
#define ARCCORE_THROW(exception_class,...)
Macro pour envoyer une exception avec formattage.
Exception lorsqu'une erreur fatale est survenue.

Macro envoyant une exception FatalErrorException.

Les arguments de la macro sont utilisés pour formatter un message d'erreur via la méthode String::format().

Définition à la ligne 552 du fichier ArccoreGlobal.h.

Référencé par Arcane::Accelerator::Impl::_applyConstituentCells(), Arcane::Accelerator::Impl::_applyGenericLoop(), Arcane::Accelerator::impl::_applyItems(), Arcane::Accelerator::Impl::DeviceStorageBase::_copyToAsync(), Arcane::Accelerator::HostDeviceReducerBase< DataType, ReduceFunctor >::_reduce(), Arcane::Accelerator::GenericFilterer::apply(), Arcane::Accelerator::GenericSorter::apply(), Arcane::Accelerator::Impl::GenericFilteringIf::apply(), Arcane::Accelerator::Impl::GenericPartitionerIf::apply(), Arcane::Accelerator::Impl::GenericPartitionerIf::apply3(), Arcane::Accelerator::GenericFilterer::applyIf(), Arcane::AbstractObserver::attachToObservable(), Arcane::basicDataTypeFromName(), Arcane::Accelerator::Impl::RunCommandLaunchInfo::beginExecute(), Arcane::BasicSerializer::copy(), Arcane::MemoryUtils::copyHost(), Arcane::Accelerator::Runner::deviceInfo(), Arcane::Accelerator::Impl::RunCommandLaunchInfo::endExecute(), Arcane::JSONValue::expectedChild(), Arcane::ITraceMng::fatalMessage(), Arcane::MemoryUtils::getMemoryResourceFromName(), Arcane::Accelerator::AcceleratorMng::initialize(), Arcane::MessagePassing::mpAllGather(), Arcane::JSONDocument::parse(), Arcane::Accelerator::WorkGroupLoopRangeBase< IsCooperativeLaunch, IndexType_ >::setBlockSize(), Arcane::Accelerator::RunQueue::setConcurrentCommandCreation(), Arcane::MessagePassing::PointToPointSerializerMng::setDefaultTag(), Arcane::MessagePassing::internal::BasicSerializeMessage::setStrategy(), Arcane::MessagePassing::PointToPointSerializerMng::setStrategy(), Arcane::String::toStdStringView(), et Arcane::Convert::ScalarType< T >::tryParseFromEnvironment().

◆ ARCCORE_FATAL_IF

#define ARCCORE_FATAL_IF ( cond,
... )
Valeur :
#define ARCCORE_THROW_IF(cond, exception_class,...)
Macro pour envoyer une exception avec formattage si cond est vrai.

Macro envoyant une exception FatalErrorException si cond est vrai.

Les arguments de la macro sont utilisés pour formatter un message d'erreur via la méthode String::format().

Voir également
ARCCORE_FATAL

Définition à la ligne 563 du fichier ArccoreGlobal.h.

◆ ARCCORE_IMPORT

#define ARCCORE_IMPORT   __attribute__((visibility("default")))

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

◆ ARCCORE_INTEGER_MAX

#define ARCCORE_INTEGER_MAX   ARCCORE_INT32_MAX

Macro indiquant la valeur maximal que peut prendre le type #Integer.

Définition à la ligne 291 du fichier ArccoreGlobal.h.

◆ ARCCORE_JOIN_HELPER

#define ARCCORE_JOIN_HELPER ( a,
b )
Valeur :
ARCCORE_JOIN_HELPER2(a, b)

Définition à la ligne 822 du fichier ArccoreGlobal.h.

◆ ARCCORE_JOIN_HELPER2

#define ARCCORE_JOIN_HELPER2 ( a,
b )
Valeur :
a##b

Définition à la ligne 821 du fichier ArccoreGlobal.h.

◆ ARCCORE_JOIN_WITH_LINE

#define ARCCORE_JOIN_WITH_LINE ( a)
Valeur :
ARCCORE_JOIN_HELPER(a, __LINE__)

Définition à la ligne 823 du fichier ArccoreGlobal.h.

◆ ARCCORE_MACRO_FUNCTION_NAME

#define ARCCORE_MACRO_FUNCTION_NAME   __func__

Définition à la ligne 705 du fichier ArccoreGlobal.h.

◆ ARCCORE_NO_DEPRECATED

#define ARCCORE_NO_DEPRECATED

Définition à la ligne 380 du fichier ArccoreGlobal.h.

◆ ARCCORE_NO_UNIQUE_ADDRESS

#define ARCCORE_NO_UNIQUE_ADDRESS   [[no_unique_address]]

Définition à la ligne 423 du fichier ArccoreGlobal.h.

◆ ARCCORE_NOEXCEPT

#define ARCCORE_NOEXCEPT   noexcept

Définition à la ligne 404 du fichier ArccoreGlobal.h.

◆ ARCCORE_NOEXCEPT_FALSE

#define ARCCORE_NOEXCEPT_FALSE   noexcept(false)

Définition à la ligne 407 du fichier ArccoreGlobal.h.

◆ ARCCORE_NORETURN

#define ARCCORE_NORETURN   [[noreturn]]

Définition à la ligne 398 du fichier ArccoreGlobal.h.

◆ ARCCORE_REAL

#define ARCCORE_REAL ( val)
Valeur :
val

Définition à la ligne 267 du fichier ArccoreGlobal.h.

◆ ARCCORE_REAL_IS_DOUBLE

#define ARCCORE_REAL_IS_DOUBLE

Définition à la ligne 268 du fichier ArccoreGlobal.h.

◆ ARCCORE_RESTRICT

#define ARCCORE_RESTRICT

Définition à la ligne 94 du fichier ArccoreGlobal.h.

◆ ARCCORE_STD

#define ARCCORE_STD   std

Définition à la ligne 97 du fichier ArccoreGlobal.h.

◆ ARCCORE_TEMPLATE_EXPORT

#define ARCCORE_TEMPLATE_EXPORT   ARCCORE_EXPORT

Définition à la ligne 62 du fichier ArccoreGlobal.h.

◆ ARCCORE_THROW

#define ARCCORE_THROW ( exception_class,
... )
Valeur :
throw exception_class(A_FUNCINFO, Arccore::String::format(__VA_ARGS__))

Macro pour envoyer une exception avec formattage.

exception_class est le type de l'exception. Les arguments suivants de la macro sont utilisés pour formatter un message d'erreur via la méthode String::format().

Définition à la ligne 527 du fichier ArccoreGlobal.h.

Référencé par Arcane::Accelerator::Impl::GenericPartitionerIf::apply(), Arcane::Accelerator::Impl::GenericPartitionerIf::apply3(), Arcane::StringUtils::convertToArcaneString(), et Arcane::StringUtils::convertToStdWString().

◆ ARCCORE_THROW_IF

#define ARCCORE_THROW_IF ( cond,
exception_class,
... )
Valeur :
if (cond) [[unlikely]] \
ARCCORE_THROW(exception_class, __VA_ARGS__)

Macro pour envoyer une exception avec formattage si cond est vrai.

exception_class est le type de l'exception. Les arguments suivants de la macro sont utilisés pour formatter un message d'erreur via la méthode String::format().

Voir également
ARCCORE_THROW

Définition à la ligne 539 du fichier ArccoreGlobal.h.

◆ ARCCORE_UNUSED

#define ARCCORE_UNUSED ( var)
Valeur :
do { \
(void)(var); \
} while (false)

Définition à la ligne 101 du fichier ArccoreGlobal.h.

◆ ARCCORE_WARNING

#define ARCCORE_WARNING ( a)

Définition à la ligne 741 du fichier ArccoreGlobal.h.

Documentation des définitions de type

◆ Int16

typedef ARCCORE_TYPE_INT16 Int16

Définition à la ligne 110 du fichier ArccoreGlobal.h.

◆ Int32

typedef ARCCORE_TYPE_INT32 Int32

Définition à la ligne 111 du fichier ArccoreGlobal.h.

◆ Int64

typedef ARCCORE_TYPE_INT64 Int64

Définition à la ligne 112 du fichier ArccoreGlobal.h.