Namespace of Arccore. More...

Namespaces
namespace	MessagePassing
	Namespace containing the types and declarations that manage the message-passing parallelism mechanism.

Classes
class	BuiltInDataTypeContainer
	Container containing an instance of a class per data type. More...
class	ExternalReferenceCounterAccessor
class	ArrayTraits
	Characteristics for an array. More...
class	ArrayTraits< T * >
	Default implementation indicating that a type is not POD. More...
class	ArrayTraits< const T * >
	Default implementation indicating that a type is not POD. More...
class	ArrayTraits< char >
class	ArrayTraits< signed char >
class	ArrayTraits< unsigned char >
class	ArrayTraits< short >
class	ArrayTraits< int >
class	ArrayTraits< long >
class	ArrayTraits< unsigned short >
class	ArrayTraits< unsigned int >
class	ArrayTraits< unsigned long >
class	ArrayTraits< float >
class	ArrayTraits< double >
class	ArrayTraits< long double >
class	ArrayTraits< std::byte >
class	ArrayTraits< Float16 >
class	ArrayTraits< BFloat16 >
class	ITraceMng
	Trace manager interface. More...
class	String
	Unicode character string. More...
class	StringBuilder
	Unicode character string constructor. More...
class	StringFormatterArg
class	StringView
	View of a UTF-8 character string. More...
class	APReal
	Emulation of real number in arbitrary precision. More...
struct	FalseType
struct	TrueType
class	Array2View
	Mutable view for a 2D array. More...
class	Array3View
	View for a 3D array. More...
class	Array4View
	View for a 4D array. More...
class	ArrayIterator
	Iterator over Arccore array classes. More...
class	ArrayView
	Modifiable view of an array of type T. More...
class	ConstArray2View
	View for a constant 2D array. More...
class	ConstArray3View
	View for a constant 3D array. More...
class	ConstArray4View
	Constant view for a 4D array. More...
class	ConstArrayView
	Constant view of an array of type T. More...
class	ConstIterT
class	IterT
class	SmallSpan
	View of an array of elements of type T. More...
class	SmallSpan2
	View for a 2D array whose size is an 'Int32'. More...
class	Span
	View of an array of elements of type T. More...
class	Span2
	View for a 2D array whose size is an 'Int64'. More...
class	Span2Impl
	View for a 2D array. More...
class	SpanImpl
	View of an array of elements of type T. More...
class	StringVector
	Vector of 'String'. More...
class	ArgumentException
	Exception when an argument is invalid. More...
class	CheckedPointer
	Encapsulation of a pointer. More...
class	Exception
	Base class for an exception. More...
class	FatalErrorException
	Exception when a fatal error has occurred. More...
class	FixedStackFrameArray
class	IndexOutOfRangeException
	Exception when a value is not within a given range. More...
class	IStackTraceService
class	NotImplementedException
class	NotSupportedException
class	Ref
	Reference to an instance. More...
class	ReferenceCounter
	Encapsulation of a pointer with a reference counter. More...
class	ReferenceCounterImpl
	Thread-safe implementation of a reference counter. More...
struct	RefTraits
	Characteristics for managing reference counters. More...
class	StackFrame
class	StackTrace
class	TimeoutException
class	TraceInfo
	Trace information. More...
class	FunctorT
class	FunctorWithArgumentT
class	IFunctor
	Interface of a functor. More...
class	IFunctorWithArgAndReturn2
	Interface of a functor with 2 arguments and a return value. More...
class	IFunctorWithArgumentT
	Interface of a functor with an argument but without a return value. More...
class	StdFunctorWithArgumentT
class	ArrayRange
	Interval over Arccore array classes. More...
struct	ReferenceCounterTag
	Structure used to tag interfaces/classes that use an internal reference counter. More...
class	AbstractArray
	Abstract base class for a vector. More...
class	AlignedMemoryAllocator
	Memory allocator with specific memory alignment. More...
class	AllocatedMemoryInfo
	Information about an allocated memory region. More...
class	Array
	Base class for 1D data vectors. More...
class	Array2
	Class representing a classic 2D array. More...
class	ArrayMetaData
class	DefaultMemoryAllocator
	Memory allocator via malloc/realloc/free. More...
class	IMemoryAllocator
	Interface for a memory allocator. More...
class	MemoryAllocationArgs
	Class containing information to specialize allocations. More...
class	MemoryAllocationOptions
	Options to configure allocations. More...
class	PrintableMemoryAllocator
	Memory allocator via malloc/realloc/free with listing output. More...
class	SharedArray
	1D vector of data with reference semantics. More...
class	SharedArray2
	Shared 2D data vector with reference semantics. More...
class	UniqueArray
	1D data vector with value semantics (STL style). More...
class	UniqueArray2
	2D data vector with value semantics (STL style). More...
class	ISerializer
	Serializer interface. More...
class	BasicSerializer

Typedefs
using	BFloat16 = Arcane::BFloat16
	Type 'Brain Float16'.
using	Float16 = Arcane::Float16
	Type 'Float16' (binary16).
using	Float32 = float
	IEEE-753 single precision floating point type (binary32).
using	Int8 = Arcane::Int8
	Type representing an 8-bit integer.
using	Float128 = Arcane::Float128
	Type representing a 128-bit float.
using	Int128 = Arcane::Int128
	Type representing a 128-bit integer.
using	Int16 = Arcane::Int16
using	Int32 = Arcane::Int32
using	Int64 = Arcane::Int64
using	eMemoryRessource = Arcane::eMemoryResource
	Typedef for the historical Arcane version (with 2's').
using	UInt32
	Unsigned integer type of 32 bits.
using	UInt64
	Unsigned integer type of 64 bits.
using	Integer
	Type representing an integer.
using	Pointer
	Type representing a pointer.
using	Real
	Type representing a real number.
using	Short
template<typename T, Int64 Extent = DynExtent>
using	LargeSpan
typedef unsigned char	Byte
	Type of a byte.
typedef signed char	SByte
	Type of a byte.
typedef float	Single
	Type of a single-precision real number.
typedef unsigned short	UChar
	Type of a unicode character.
typedef unsigned short	UInt16
	Type of an unsigned Int16.
typedef ArrayView< bool >	BoolArrayView
	C equivalent of a 1D array of booleans.
typedef ArrayView< Byte >	ByteArrayView
	C equivalent of a 1D array of characters.
typedef ArrayView< Int16 >	Int16ArrayView
	C equivalent of a 1D array of 16-bit integers.
typedef ArrayView< Int32 >	Int32ArrayView
	C equivalent of a 1D array of 32-bit integers.
typedef ArrayView< Int64 >	Int64ArrayView
	C equivalent of a 1D array of 64-bit integers.
typedef ArrayView< Integer >	IntegerArrayView
	C equivalent of a 1D array of integers.
typedef ArrayView< Pointer >	PointerArrayView
	C equivalent of a 1D array of pointers.
typedef ArrayView< Real >	RealArrayView
	C equivalent of a 1D array of reals.
typedef ArrayView< UChar >	UCharArrayView
	C equivalent of a 1D array of unicode characters.
typedef ConstArrayView< bool >	BoolConstArrayView
	C equivalent of a 1D array of booleans.
typedef ConstArrayView< Byte >	ByteConstArrayView
	C equivalent of a 1D array of characters.
typedef ConstArrayView< Int16 >	Int16ConstArrayView
	C equivalent of a 1D array of 16-bit integers.
typedef ConstArrayView< Int32 >	Int32ConstArrayView
	C equivalent of a 1D array of 32-bit integers.
typedef ConstArrayView< Int64 >	Int64ConstArrayView
	C equivalent of a 1D array of 64-bit integers.
typedef ConstArrayView< Integer >	IntegerConstArrayView
	C equivalent of a 1D array of integers.
typedef ConstArrayView< Pointer >	PointerConstArrayView
	C equivalent of a 1D array of pointers.
typedef ConstArrayView< Real >	RealConstArrayView
	C equivalent of a 1D array of reals.
typedef ConstArrayView< UChar >	UCharConstArrayView
	C equivalent of a 1D array of unicode characters.
typedef Span< bool >	BoolSpan
	C equivalent of a 1D array of booleans.
typedef Span< std::byte >	ByteSpan
	C equivalent of a 1D array of characters.
typedef Span< Int16 >	Int16Span
	C equivalent of a 1D array of 16-bit integers.
typedef Span< Int32 >	Int32Span
	C equivalent of a 1D array of 32-bit integers.
typedef Span< Int64 >	Int64Span
	C equivalent of a 1D array of 64-bit integers.
typedef Span< Integer >	IntegerSpan
	C equivalent of a 1D array of integers.
typedef Span< Pointer >	PointerSpan
	C equivalent of a one-dimensional array of pointers.
typedef Span< Real >	RealSpan
	C equivalent of a 1D array of reals.
typedef Span< UChar >	UCharSpan
	C equivalent of a 1D array of unicode characters.
typedef Span< const bool >	BoolConstSpan
	Read-only view of a 1D array of booleans.
typedef Span< const std::byte >	ByteConstSpan
	Read-only view of a 1D array of characters.
typedef Span< const Int16 >	Int16ConstSpan
	Read-only view of a 1D array of 16-bit integers.
typedef Span< const Int32 >	Int32ConstSpan
	Read-only view of a 1D array of 32-bit integers.
typedef Span< const Int64 >	Int64ConstSpan
	Read-only view of a 1D array of 64-bit integers.
typedef Span< const Integer >	IntegerConstSpan
	Read-only view of a 1D array of integers.
typedef Span< const Pointer >	PointerConstSpan
	Read-only view of a 1D array of pointers.
typedef Span< const Real >	RealConstSpan
	Read-only view of a 1D array of reals.
typedef Span< const UChar >	UCharConstSpan
	Read-only view of a 1D array of unicode characters.
using	AlignedMemoryAllocator3
using	DefaultMemoryAllocator3
using	IMemoryAllocator3

Enumerations
enum class	eBasicDataType
	Type of a basic data item. More...
enum class	eBasicDataType
	Type of a basic data item. More...
enum class	eHostDeviceMemoryLocation
	Physical location of a memory address. More...
enum class	eMemoryLocationHint
	Indices for expected memory location. More...
enum class	eMemoryResource
	List of available memory resources. More...

Functions
	ARCCORE_DEFINE_REFERENCE_COUNTED_CLASS (Arcane::ICaseOptionList)
	ARCCORE_DEFINE_REFERENCE_COUNTED_CLASS (Arcane::IData)
	ARCCORE_DEFINE_REFERENCE_COUNTED_CLASS (Arcane::ISerializedData)
	ARCCORE_DEFINE_REFERENCE_COUNTED_CLASS (Arcane::IParallelMng)
	ARCCORE_DEFINE_REFERENCE_COUNTED_CLASS (Arcane::IParallelMngContainer)
	ARCCORE_DEFINE_ARRAY_PODTYPE (Arcane::Materials::MatVarIndex)
	ARCCORE_DEFINE_ARRAY_PODTYPE (Arcane::Materials::ConstituentItemIndex)
	ARCCORE_DEFINE_REFERENCE_COUNTED_CLASS (Arcane::DependencyInjection::impl::IInstanceFactory)
	ARCCORE_DEFINE_REFERENCE_COUNTED_CLASS (Arcane::IThreadImplementation)
	ARCCORE_DEFINE_REFERENCE_COUNTED_CLASS (Arcane::ITraceMng)
	ARCCORE_DEFINE_REFERENCE_COUNTED_CLASS (Arcane::ITraceStream)
__host__ __device__ void	arccoreCheckAt (Int64 i, Int64 max_size)
	Checks for potential array overflow.
__host__ __device__ void	arccoreCheckRange (Int64 i, Int64 min_value_inclusive, Int64 max_value_exclusive)
	Checks that min_value_inclusive <= i < max_value_exclusive.
void	arccoreDebugPause (const char *msg)
	Enters pause mode or throws a fatal error.
bool	arccoreIsCheck ()
	True if in check mode.
bool	arccoreIsDebug ()
	True if the ARCCORE_DEBUG macro is defined.
void	arccoreNullPointerError ()
	Signals the use of a null pointer.
void	arccorePrintf (const char *,...)
	Encapsulation of the C printf function.
void	arccoreRangeError (Int64 i, Int64 min_value_inclusive, Int64 max_value_exclusive)
	Signals that a value is not within the desired range.
void	arccoreSetCheck (bool v)
	Activates or deactivates check mode.
void	arccoreSetPauseOnError (bool v)
	Indicates whether calling arccoreDebugPause() results in a pause.
void *	arccoreThrowIfNull (void ptr, const char ptr_name, const char *text)
	Checks that a pointer is not null.
void	arccoreThrowNullPointerError (const char ptr_name, const char text)
	Signals the use of a null pointer by throwing an exception.
template<typename T>
T *	_checkPointer (const T t, const char file, const char *func, int line)
void	_doAssert (const char text, const char file, const char *func, size_t line)
constexpr __host__ __device__ Integer	arccoreCheckArraySize (unsigned long long size)
	Checks that size can be converted into an 'Integer' to serve as an array size. If possible, returns size converted to an 'Integer'. Otherwise, throws an ArgumentException.
constexpr __host__ __device__ Int64	arccoreCheckLargeArraySize (size_t size)
	Checks that size can be converted into an 'Int64' to serve as an array size.
eBasicDataType	basicDataTypeFromName (const char *name, bool &has_error)
	Finds the type associated with name.
const char *	basicDataTypeName (eBasicDataType type)
	Data type name.
Integer	basicDataTypeSize (eBasicDataType type)
	Size of data type type.
template<typename TrueType, class... Args>
Ref< TrueType >	createRef (Args &&... args)
	Creates an instance of type TrueType with arguments Args and returns a reference to it.
template<typename InstanceType>
auto	makeRef (InstanceType *t) -> Ref< InstanceType >
	Creates a reference on a pointer.
template<typename InstanceType, typename InstanceType2, typename std::enable_if_t< Ref< InstanceType >::RefType, int > = REF_TAG_REFERENCE_COUNTER>
Ref< InstanceType >	makeRefFromInstance (InstanceType2 *t)
	Retrieves a reference on the pointer t.
template<typename DataType, typename SizeType, SizeType Extent>
Impl::SpanTypeFromSize< conststd::byte, SizeType >::SpanType	asBytes (const SpanImpl< DataType, SizeType, Extent > &s)
	Converts the view into an array of non-modifiable bytes.
template<typename DataType, Int32 Extent>
SmallSpan< DataType >	asSmallSpan (SmallSpan< std::byte, Extent > bytes)
	Converts a SmallSpan<std::byte> into a SmallSpan<DataType>.
template<typename DataType, Int64 Extent>
Span< DataType >	asSpan (Span< std::byte, Extent > bytes)
	Converts a Span<std::byte> into a Span<DataType>.
template<typename DataType, typename SizeType, SizeType Extent, typename std::enable_if_t<!std::is_const< DataType >::value, int > = 0>
Impl::SpanTypeFromSize< std::byte, SizeType >::SpanType	asWritableBytes (const SpanImpl< DataType, SizeType, Extent > &s)
	Converts the view into an array of modifiable bytes.
void	binaryRead (std::istream &istr, const Span< std::byte > &bytes)
	Reads the content of bytes from the stream istr in binary format.
void	binaryWrite (std::ostream &ostr, const Span< const std::byte > &bytes)
	Writes the content of bytes to the stream ostr in binary format.
template<typename DataType>
void	sampleSpan (Span< const DataType > values, Span< const Int64 > indexes, Span< DataType > result)
	Extracts a sub-array from a list of indices.
ARCCORE_TRACE_EXPORT ITraceMng *	arccoreCreateDefaultTraceMng ()
ARCCORE_SERIALIZE_EXPORT Ref< ISerializer >	createSerializer ()
	Creates an instance of ISerializer.

Variables
constexpr Int32	DynExtent
	Constant to indicate that an array dimension is dynamic.
constexpr unsigned char	NB_BASIC_DATA_TYPE
	Number of supported basic types.

Detailed Description

Namespace of Arccore.

All classes and types used in Arccore are in this namespace.

Typedef Documentation

◆ AlignedMemoryAllocator3

using Arcane::AlignedMemoryAllocator3

Definition at line 43 of file CollectionsGlobal.h.

◆ BFloat16

using Arccore::BFloat16 = Arcane::BFloat16

Type 'Brain Float16'.

Definition at line 861 of file ArccoreGlobal.h.

◆ BoolArrayView

typedef ArrayView< bool > Arcane::BoolArrayView

C equivalent of a 1D array of booleans.

C equivalent of a one-dimensional array of booleans.

Definition at line 461 of file UtilsTypes.h.

◆ BoolConstArrayView

typedef ConstArrayView< bool > Arcane::BoolConstArrayView

C equivalent of a 1D array of booleans.

C equivalent of a one-dimensional array of booleans.

Definition at line 490 of file UtilsTypes.h.

◆ BoolConstSpan

typedef Span< const bool > Arcane::BoolConstSpan

Read-only view of a 1D array of booleans.

C equivalent of a one-dimensional array of booleans.

Definition at line 562 of file UtilsTypes.h.

◆ BoolSpan

typedef Span< bool > Arcane::BoolSpan

C equivalent of a 1D array of booleans.

C equivalent of a one-dimensional array of booleans.

Definition at line 530 of file UtilsTypes.h.

◆ Byte

typedef unsigned char Arcane::Byte

Type of a byte.

Definition at line 43 of file BaseTypes.h.

◆ ByteArrayView

typedef ArrayView< Byte > Arcane::ByteArrayView

C equivalent of a 1D array of characters.

C equivalent of a one-dimensional array of characters.

Definition at line 447 of file UtilsTypes.h.

◆ ByteConstArrayView

typedef ConstArrayView< Byte > Arcane::ByteConstArrayView

C equivalent of a 1D array of characters.

C equivalent of a one-dimensional array of characters.

Definition at line 476 of file UtilsTypes.h.

◆ ByteConstSpan

typedef Span< const std::byte > Arcane::ByteConstSpan

Read-only view of a 1D array of characters.

C equivalent of a one-dimensional array of characters.

Definition at line 548 of file UtilsTypes.h.

◆ ByteSpan

typedef Span< std::byte > Arcane::ByteSpan

C equivalent of a 1D array of characters.

C equivalent of a one-dimensional array of characters.

Definition at line 516 of file UtilsTypes.h.

◆ DefaultMemoryAllocator3

using Arcane::DefaultMemoryAllocator3

Definition at line 44 of file CollectionsGlobal.h.

◆ eMemoryRessource

using Arccore::eMemoryRessource = Arcane::eMemoryResource

Typedef for the historical Arcane version (with 2's').

Definition at line 91 of file CollectionsGlobal.h.

◆ Float128

using Arccore::Float128 = Arcane::Float128

Type representing a 128-bit float.

Definition at line 873 of file ArccoreGlobal.h.

◆ Float16

using Arccore::Float16 = Arcane::Float16

Type 'Float16' (binary16).

Definition at line 864 of file ArccoreGlobal.h.

◆ Float32

using Arccore::Float32 = float

IEEE-753 single precision floating point type (binary32).

Definition at line 867 of file ArccoreGlobal.h.

◆ IMemoryAllocator3

using Arcane::IMemoryAllocator3

Definition at line 42 of file CollectionsGlobal.h.

◆ Int128

using Arccore::Int128 = Arcane::Int128

Type representing a 128-bit integer.

Definition at line 876 of file ArccoreGlobal.h.

◆ Int16

using Arccore::Int16 = Arcane::Int16

Definition at line 877 of file ArccoreGlobal.h.

◆ Int16ArrayView

typedef ArrayView< Int16 > Arcane::Int16ArrayView

C equivalent of a 1D array of 16-bit integers.

C equivalent of a one-dimensional array of 16-bit integers.

Definition at line 455 of file UtilsTypes.h.

◆ Int16ConstArrayView

typedef ConstArrayView< Int16 > Arcane::Int16ConstArrayView

C equivalent of a 1D array of 16-bit integers.

C equivalent of a one-dimensional array of 16-bit integers.

Definition at line 484 of file UtilsTypes.h.

◆ Int16ConstSpan

typedef Span< const Int16 > Arcane::Int16ConstSpan

Read-only view of a 1D array of 16-bit integers.

C equivalent of a one-dimensional array of 16-bit integers.

Definition at line 556 of file UtilsTypes.h.

◆ Int16Span

typedef Span< Int16 > Arcane::Int16Span

C equivalent of a 1D array of 16-bit integers.

C equivalent of a one-dimensional array of 16-bit integers.

Definition at line 524 of file UtilsTypes.h.

◆ Int32

using Arccore::Int32 = Arcane::Int32

Definition at line 878 of file ArccoreGlobal.h.

◆ Int32ArrayView

typedef ArrayView< Int32 > Arcane::Int32ArrayView

C equivalent of a 1D array of 32-bit integers.

C equivalent of a one-dimensional array of 32-bit integers.

Definition at line 453 of file UtilsTypes.h.

◆ Int32ConstArrayView

typedef ConstArrayView< Int32 > Arcane::Int32ConstArrayView

C equivalent of a 1D array of 32-bit integers.

C equivalent of a one-dimensional array of 32-bit integers.

Definition at line 482 of file UtilsTypes.h.

◆ Int32ConstSpan

typedef Span< const Int32 > Arcane::Int32ConstSpan

Read-only view of a 1D array of 32-bit integers.

C equivalent of a one-dimensional array of 32-bit integers.

Definition at line 554 of file UtilsTypes.h.

◆ Int32Span

typedef Span< Int32 > Arcane::Int32Span

C equivalent of a 1D array of 32-bit integers.

C equivalent of a one-dimensional array of 32-bit integers.

Definition at line 522 of file UtilsTypes.h.

◆ Int64

using Arccore::Int64 = Arcane::Int64

Definition at line 879 of file ArccoreGlobal.h.

◆ Int64ArrayView

typedef ArrayView< Int64 > Arcane::Int64ArrayView

C equivalent of a 1D array of 64-bit integers.

C equivalent of a one-dimensional array of 64-bit integers.

Definition at line 451 of file UtilsTypes.h.

◆ Int64ConstArrayView

typedef ConstArrayView< Int64 > Arcane::Int64ConstArrayView

C equivalent of a 1D array of 64-bit integers.

C equivalent of a one-dimensional array of 64-bit integers.

Definition at line 480 of file UtilsTypes.h.

◆ Int64ConstSpan

typedef Span< const Int64 > Arcane::Int64ConstSpan

Read-only view of a 1D array of 64-bit integers.

C equivalent of a one-dimensional array of 64-bit integers.

Definition at line 552 of file UtilsTypes.h.

◆ Int64Span

typedef Span< Int64 > Arcane::Int64Span

C equivalent of a 1D array of 64-bit integers.

C equivalent of a one-dimensional array of 64-bit integers.

Definition at line 520 of file UtilsTypes.h.

◆ Int8

using Arccore::Int8 = Arcane::Int8

Type representing an 8-bit integer.

Definition at line 870 of file ArccoreGlobal.h.

◆ Integer

using Arcane::Integer

Type representing an integer.

If the ARCANE_64BIT macro is defined, the Integer type corresponds to an Int64 integer, otherwise to an Int32 integer.

If the ARCCORE_64BIT macro is defined, the Integer type corresponds to an Int64 integer, otherwise to an Int32 integer.

Definition at line 293 of file ArccoreGlobal.h.

◆ IntegerArrayView

typedef ArrayView< Integer > Arcane::IntegerArrayView

C equivalent of a 1D array of integers.

C equivalent of a one-dimensional array of integers.

Definition at line 457 of file UtilsTypes.h.

◆ IntegerConstArrayView

typedef ConstArrayView< Integer > Arcane::IntegerConstArrayView

C equivalent of a 1D array of integers.

C equivalent of a one-dimensional array of integers.

Definition at line 486 of file UtilsTypes.h.

◆ IntegerConstSpan

typedef Span< const Integer > Arcane::IntegerConstSpan

Read-only view of a 1D array of integers.

C equivalent of a one-dimensional array of integers.

Definition at line 558 of file UtilsTypes.h.

◆ IntegerSpan

typedef Span< Integer > Arcane::IntegerSpan

C equivalent of a 1D array of integers.

C equivalent of a one-dimensional array of integers.

Definition at line 526 of file UtilsTypes.h.

◆ LargeSpan

template<typename T, Int64 Extent = DynExtent>

using Arcane::LargeSpan

Definition at line 67 of file BaseTypes.h.

◆ Pointer

using Arcane::Pointer

Type representing a pointer.

It must be used everywhere an object of any pointer type is expected.

Definition at line 249 of file ArccoreGlobal.h.

◆ PointerArrayView

typedef ArrayView< Pointer > Arcane::PointerArrayView

C equivalent of a 1D array of pointers.

C equivalent of a one-dimensional array of pointers.

Definition at line 445 of file UtilsTypes.h.

◆ PointerConstArrayView

typedef ConstArrayView< Pointer > Arcane::PointerConstArrayView

C equivalent of a 1D array of pointers.

C equivalent of a one-dimensional array of pointers.

Definition at line 474 of file UtilsTypes.h.

◆ PointerConstSpan

typedef Span< const Pointer > Arcane::PointerConstSpan

Read-only view of a 1D array of pointers.

C equivalent of a one-dimensional array of pointers.

Definition at line 546 of file UtilsTypes.h.

◆ PointerSpan

typedef Span< Pointer > Arcane::PointerSpan

C equivalent of a one-dimensional array of pointers.

Definition at line 514 of file UtilsTypes.h.

◆ Real

using Arcane::Real

Type representing a real number.

It must be used everywhere a real number object is expected.

Definition at line 275 of file ArccoreGlobal.h.

◆ RealArrayView

typedef ArrayView< Real > Arcane::RealArrayView

C equivalent of a 1D array of reals.

C equivalent of a one-dimensional array of reals.

Definition at line 459 of file UtilsTypes.h.

◆ RealConstArrayView

typedef ConstArrayView< Real > Arcane::RealConstArrayView

C equivalent of a 1D array of reals.

C equivalent of a one-dimensional array of reals.

Definition at line 488 of file UtilsTypes.h.

◆ RealConstSpan

typedef Span< const Real > Arcane::RealConstSpan

Read-only view of a 1D array of reals.

C equivalent of a one-dimensional array of reals.

Definition at line 560 of file UtilsTypes.h.

◆ RealSpan

typedef Span< Real > Arcane::RealSpan

C equivalent of a 1D array of reals.

C equivalent of a one-dimensional array of reals.

Definition at line 528 of file UtilsTypes.h.

◆ SByte

typedef signed char Arcane::SByte

Type of a byte.

Definition at line 45 of file BaseTypes.h.

◆ Short

using Arcane::Short

Definition at line 292 of file ArccoreGlobal.h.

◆ Single

typedef float Arcane::Single

Type of a single-precision real number.

Definition at line 51 of file BaseTypes.h.

◆ UChar

typedef unsigned short Arcane::UChar

Type of a unicode character.

Definition at line 47 of file BaseTypes.h.

◆ UCharArrayView

typedef ArrayView< UChar > Arcane::UCharArrayView

C equivalent of a 1D array of unicode characters.

C equivalent of a one-dimensional array of unicode characters.

Definition at line 449 of file UtilsTypes.h.

◆ UCharConstArrayView

typedef ConstArrayView< UChar > Arcane::UCharConstArrayView

C equivalent of a 1D array of unicode characters.

C equivalent of a one-dimensional array of unicode characters.

Definition at line 478 of file UtilsTypes.h.

◆ UCharConstSpan

typedef Span< const UChar > Arcane::UCharConstSpan

Read-only view of a 1D array of unicode characters.

C equivalent of a one-dimensional array of unicode characters.

Definition at line 550 of file UtilsTypes.h.

◆ UCharSpan

typedef Span< UChar > Arcane::UCharSpan

C equivalent of a 1D array of unicode characters.

C equivalent of a one-dimensional array of unicode characters.

Definition at line 518 of file UtilsTypes.h.

◆ UInt16

typedef unsigned short Arcane::UInt16

Type of an unsigned Int16.

Definition at line 49 of file BaseTypes.h.

◆ UInt32

using Arcane::UInt32

Unsigned integer type of 32 bits.

Definition at line 237 of file ArccoreGlobal.h.

◆ UInt64

using Arcane::UInt64

Unsigned integer type of 64 bits.

Definition at line 239 of file ArccoreGlobal.h.

Enumeration Type Documentation

◆ eBasicDataType [1/2]

enum class Arcane::eBasicDataType : unsigned char

strong

Type of a basic data item.

Note: : The values must be contiguous and fit into one byte and must not be modified because they are used for serialization, for example. However, it is possible to add them.

Definition at line 37 of file arccore/src/base/arccore/base/BasicDataType.h.

◆ eBasicDataType [2/2]

enum class Arcane::eBasicDataType : unsigned char

strong

Type of a basic data item.

Note: : The values must be contiguous and fit into one byte and must not be modified because they are used for serialization, for example. However, it is possible to add them.

Definition at line 37 of file arccore/src/base/arccore/base/BasicDataType.h.

◆ eHostDeviceMemoryLocation

enum class Arcane::eHostDeviceMemoryLocation : int8_t

strong

Physical location of a memory address.

For the ManagedMemoryDevice and ManagedMemoryHost values, this is an indication because there is no simple way to know where the memory is actually located.

Definition at line 155 of file CommonGlobal.h.

◆ eMemoryLocationHint

enum class Arcane::eMemoryLocationHint : int8_t

strong

Indices for expected memory location.

Definition at line 130 of file CommonGlobal.h.

◆ eMemoryResource

enum class Arcane::eMemoryResource

strong

List of available memory resources.

Definition at line 178 of file CommonGlobal.h.

Function Documentation

◆ _checkPointer()

template<typename T>

T * Arcane::_checkPointer	(	const T *	t,
		const char *	file,
		const char *	func,
		int	line )

inline

Definition at line 681 of file ArccoreGlobal.h.

◆ _doAssert()

void Arcane::_doAssert	(	const char *	text,
		const char *	file,
		const char *	func,
		size_t	line )

Displaying a failed assertion.

Definition at line 220 of file Misc.cc.

◆ arccoreCheckArraySize()

__host__ __device__ Integer Arcane::arccoreCheckArraySize ( unsigned long long size )

inlineconstexpr

Checks that size can be converted into an 'Integer' to serve as an array size. If possible, returns size converted to an 'Integer'. Otherwise, throws an ArgumentException.

Definition at line 203 of file ArrayViewCommon.h.

◆ arccoreCheckAt()

__host__ __device__ void Arcane::arccoreCheckAt	(	Int64	i,
		Int64	max_size )

inline

Checks for potential array overflow.

Calls arccoreCheckRange(i,0,max_size).

Definition at line 644 of file ArccoreGlobal.h.

◆ arccoreCheckLargeArraySize()

__host__ __device__ Int64 Arcane::arccoreCheckLargeArraySize ( size_t size )

inlineconstexpr

Checks that size can be converted into an 'Int64' to serve as an array size.

If possible, returns size converted to an 'Int64'. Otherwise, throws an ArgumentException.

Definition at line 286 of file ArrayViewCommon.h.

◆ arccoreCheckRange()

__host__ __device__ void Arcane::arccoreCheckRange	(	Int64	i,
		Int64	min_value_inclusive,
		Int64	max_value_exclusive )

inline

Checks that min_value_inclusive <= i < max_value_exclusive.

If this is not the case, calls arccoreRangeError() to throw an exception.

Definition at line 621 of file ArccoreGlobal.h.

◆ arccoreCreateDefaultTraceMng()

ARCCORE_TRACE_EXPORT ITraceMng * Arcane::arccoreCreateDefaultTraceMng ( )

Definition at line 534 of file arccore/src/trace/arccore/trace/TraceMng.cc.

◆ arccoreDebugPause()

void Arcane::arccoreDebugPause ( const char * msg )

Enters pause mode or throws a fatal error.

If arccoreSetPauseOnError() is called with the argument true, it pauses the program to potentially attach a debugger.

Otherwise, it throws a FatalErrorException with the message msg as an argument.

Definition at line 114 of file ArccoreGlobal.cc.

◆ arccoreIsCheck()

bool Arcane::arccoreIsCheck ( )

True if in check mode.

This mode is active if the ARCCORE_CHECK macro is defined or if the arccoreSetCheck() method has been set to true.

Definition at line 80 of file ArccoreGlobal.cc.

◆ arccoreIsDebug()

bool Arcane::arccoreIsDebug ( )

True if the ARCCORE_DEBUG macro is defined.

Definition at line 90 of file ArccoreGlobal.cc.

◆ arccoreNullPointerError()

void Arcane::arccoreNullPointerError ( )

Signals the use of a null pointer.

Signals an attempt to use a null pointer. Displays a message, calls arccoreDebugPause(), and throws a FatalErrorException.

Definition at line 165 of file ArccoreGlobal.cc.

◆ arccorePrintf()

void Arcane::arccorePrintf	(	const char *	format,
			... )

Encapsulation of the C printf function.

Definition at line 270 of file ArccoreGlobal.cc.

◆ arccoreRangeError()

void Arcane::arccoreRangeError	(	Int64	i,
		Int64	min_value_inclusive,
		Int64	max_value_exclusive )

Signals that a value is not within the desired range.

Indicates that the assertion min_value_inclusive <= i < max_value_exclusive is false. Calls arccoreDebugPause() then throws an IndexOutOfRangeException.

Parameters

i	invalid value.
min_value_inclusive	allowed minimum inclusive value.
max_value_exclusive	allowed maximum exclusive value.

Definition at line 135 of file ArccoreGlobal.cc.

◆ arccoreSetCheck()

void Arcane::arccoreSetCheck ( bool v )

Activates or deactivates check mode.

Check mode is always active if the ARCCORE_CHECK macro is defined. Otherwise, it is possible to activate it using this method. This allows certain tests to be enabled even in optimized mode.

Definition at line 85 of file ArccoreGlobal.cc.

◆ arccoreSetPauseOnError()

void Arcane::arccoreSetPauseOnError ( bool v )

Indicates whether calling arccoreDebugPause() results in a pause.

See also: arccoreDebugPause()

Definition at line 108 of file ArccoreGlobal.cc.

◆ arccoreThrowIfNull()

void * Arcane::arccoreThrowIfNull	(	void *	ptr,
		const char *	ptr_name,
		const char *	text )

inline

Checks that a pointer is not null.

If the pointer is null, calls arccoreThrowNullPointerError(). Otherwise, returns the pointer.

Definition at line 767 of file ArccoreGlobal.h.

◆ arccoreThrowNullPointerError()

void Arcane::arccoreThrowNullPointerError	(	const char *	ptr_name,
		const char *	text )

Signals the use of a null pointer by throwing an exception.

Signals an attempt to use a null pointer. Throws a FatalErrorException.

In the exception, displays text if not null, otherwise displays ptr_name.

Normally this method should not be called directly but via the ARCCORE_CHECK_POINTER macro.

Definition at line 177 of file ArccoreGlobal.cc.

◆ asBytes()

template<typename DataType, typename SizeType, SizeType Extent>

Impl::SpanTypeFromSize< conststd::byte, SizeType >::SpanType Arcane::asBytes ( const SpanImpl< DataType, SizeType, Extent > & s )

inline

Converts the view into an array of non-modifiable bytes.

Definition at line 1032 of file Span.h.

◆ asSmallSpan()

template<typename DataType, Int32 Extent>

SmallSpan< DataType > Arcane::asSmallSpan ( SmallSpan< std::byte, Extent > bytes )

inline

Converts a SmallSpan<std::byte> into a SmallSpan<DataType>.

Precondition: bytes.size() % sizeof(DataType) == 0;

Definition at line 1146 of file Span.h.

◆ asSpan()

template<typename DataType, Int64 Extent>

Span< DataType > Arcane::asSpan ( Span< std::byte, Extent > bytes )

inline

Converts a Span<std::byte> into a Span<DataType>.

Precondition: bytes.size() % sizeof(DataType) == 0;

Definition at line 1126 of file Span.h.

◆ asWritableBytes()

template<typename DataType, typename SizeType, SizeType Extent, typename std::enable_if_t<!std::is_const< DataType >::value, int > = 0>

Impl::SpanTypeFromSize< std::byte, SizeType >::SpanType Arcane::asWritableBytes ( const SpanImpl< DataType, SizeType, Extent > & s )

inline

Converts the view into an array of modifiable bytes.

This method is only accessible if DataType is not const.

Definition at line 1068 of file Span.h.

◆ basicDataTypeFromName()

eBasicDataType Arcane::basicDataTypeFromName	(	const char *	name,
		bool &	has_error )

Finds the type associated with name.

Definition at line 97 of file BasicDataType.cc.

◆ basicDataTypeName()

const char * Arcane::basicDataTypeName ( eBasicDataType type )

Data type name.

Definition at line 75 of file BasicDataType.cc.

◆ basicDataTypeSize()

Integer Arcane::basicDataTypeSize ( eBasicDataType type )

Size of data type type.

Definition at line 114 of file BasicDataType.cc.

◆ binaryRead()

void Arcane::binaryRead	(	std::istream &	istr,
		const Span< std::byte > &	bytes )

Reads the content of bytes from the stream istr in binary format.

This is equivalent to calling istr.read(bytes.data(),bytes.size());

Definition at line 102 of file ArrayView.cc.

◆ binaryWrite()

void Arcane::binaryWrite	(	std::ostream &	ostr,
		const Span< const std::byte > &	bytes )

Writes the content of bytes to the stream ostr in binary format.

This is equivalent to calling ostr.write(bytes.data(),bytes.size());

Definition at line 93 of file ArrayView.cc.

◆ createRef()

template<typename TrueType, class... Args>

Ref< TrueType > Arcane::createRef ( Args &&... args )

inline

Creates an instance of type TrueType with arguments Args and returns a reference to it.

Definition at line 464 of file arccore/src/base/arccore/base/Ref.h.

◆ createSerializer()

Ref< ISerializer > Arcane::createSerializer ( )

Creates an instance of ISerializer.

Definition at line 183 of file SerializeGlobal.cc.

◆ makeRef()

template<typename InstanceType>

auto Arcane::makeRef ( InstanceType * t ) -> Ref< InstanceType >

inline

Creates a reference on a pointer.

The pointer t must have been allocated by the 'operator new' operator and will be destroyed by the 'operator delete' operator when there is no longer a reference to it.

Definition at line 425 of file arccore/src/base/arccore/base/Ref.h.

◆ makeRefFromInstance()

template<typename InstanceType, typename InstanceType2, typename std::enable_if_t< Ref< InstanceType >::RefType, int > = REF_TAG_REFERENCE_COUNTER>

Ref< InstanceType > Arcane::makeRefFromInstance ( InstanceType2 * t )

inline

Retrieves a reference on the pointer t.

This method is only available if the class InstanceType uses a reference counter (ImplTagId==REF_TAG_REFERENCE_COUNTER).

class A {};
class B : public A {};
Ref<B> rb = ...;
B* b = rb.get();
Ref<A> ra = makeRefFromInstance<A>(b);

Definition at line 451 of file arccore/src/base/arccore/base/Ref.h.

◆ sampleSpan()

template<typename DataType>

void Arcane::sampleSpan	(	Span< const DataType >	values,
		Span< const Int64 >	indexes,
		Span< DataType >	result )

inline

Extracts a sub-array from a list of indices.

Fills result with the values from the array values corresponding to the indices indexes.

Precondition: results.size() >= indexes.size();

Definition at line 1004 of file Span.h.

Variable Documentation

◆ DynExtent

Int32 Arcane::DynExtent

inlineconstexpr

Constant to indicate that an array dimension is dynamic.

Definition at line 54 of file BaseTypes.h.

◆ NB_BASIC_DATA_TYPE

unsigned char Arcane::NB_BASIC_DATA_TYPE

constexpr

Number of supported basic types.

Definition at line 54 of file arccore/src/base/arccore/base/BasicDataType.h.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ AlignedMemoryAllocator3

◆ BFloat16

◆ BoolArrayView

◆ BoolConstArrayView

◆ BoolConstSpan

◆ BoolSpan

◆ Byte

◆ ByteArrayView

◆ ByteConstArrayView

◆ ByteConstSpan

◆ ByteSpan

◆ DefaultMemoryAllocator3

◆ eMemoryRessource

◆ Float128

◆ Float16

◆ Float32

◆ IMemoryAllocator3

◆ Int128

◆ Int16

◆ Int16ArrayView

◆ Int16ConstArrayView

◆ Int16ConstSpan

◆ Int16Span

◆ Int32

◆ Int32ArrayView

◆ Int32ConstArrayView

◆ Int32ConstSpan

◆ Int32Span

◆ Int64

◆ Int64ArrayView

◆ Int64ConstArrayView

◆ Int64ConstSpan

◆ Int64Span

◆ Int8

◆ Integer

◆ IntegerArrayView

◆ IntegerConstArrayView

◆ IntegerConstSpan

◆ IntegerSpan

◆ LargeSpan

◆ Pointer

◆ PointerArrayView

◆ PointerConstArrayView

◆ PointerConstSpan

◆ PointerSpan

◆ Real

◆ RealArrayView

◆ RealConstArrayView

◆ RealConstSpan

◆ RealSpan

◆ SByte

◆ Short

◆ Single

◆ UChar

◆ UCharArrayView

◆ UCharConstArrayView

◆ UCharConstSpan

◆ UCharSpan

◆ UInt16

◆ UInt32

◆ UInt64

Enumeration Type Documentation

◆ eBasicDataType [1/2]

◆ eBasicDataType [2/2]

◆ eHostDeviceMemoryLocation

◆ eMemoryLocationHint

◆ eMemoryResource

Function Documentation

◆ _checkPointer()

◆ _doAssert()

◆ arccoreCheckArraySize()

◆ arccoreCheckAt()