BaseTypes.h

Aller à la documentation de ce fichier.

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2025 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* BaseTypes.h                                                 (C) 2000-2025 */
/*                                                                           */
/* Définition des types de la composante 'base' de Arccore.                  */
/*---------------------------------------------------------------------------*/
#ifndef ARCCORE_BASE_BASETYPES_H
#define ARCCORE_BASE_BASETYPES_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/base/ArccoreGlobal.h"
 
#include <cstddef>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*!
 * \file BaseTypes.h
 *
 * \brief Déclarations des types de la composante 'base' de %Arccore.
 */
 
template <typename T> class IterT;
template <typename T> class ConstIterT;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
//! Type d'un octet
typedef unsigned char Byte;
//! Type d'un octet
typedef signed char SByte;
//! Type d'un caractère unicode
typedef unsigned short UChar;
//! Type d'un Int16 non signé
typedef unsigned short UInt16;
//! Type d'un réel simple précision
typedef float Single;
 
//! Constante pour indiquer que la dimension d'un tableau est dynamique
inline constexpr Int32 DynExtent = -1;
 
template <typename T> class ConstArrayView;
template <typename T> class ArrayView;
template <typename T> class ConstArray2View;
template <typename T> class Array2View;
template <typename T> class ConstArray3View;
template <typename T> class Array3View;
template <typename T> class ConstArray4View;
template <typename T> class Array4View;
template <typename T, typename SizeType, SizeType Extent = DynExtent> class SpanImpl;
template <typename T, Int64 Extent = DynExtent> class Span;
template <typename T, Int32 Extent = DynExtent> class SmallSpan;
template <typename T, Int64 Extent = DynExtent> using LargeSpan = Span<T, Extent>;
template <typename T, typename SizeType, SizeType Extent1 = DynExtent, SizeType Extent2 = DynExtent> class Span2Impl;
template <typename T, Int64 Extent1 = DynExtent, Int64 Extent2 = DynExtent> class Span2;
template <typename T, Int32 Extent1 = DynExtent, Int32 Extent2 = DynExtent> class SmallSpan2;
template <typename Iterator_>
class ArrayIterator;
 
class StringImpl;
class String;
class StringVector;
class StringBuilder;
class StringFormatterArg;
struct ReferenceCounterTag;
 
class IRangeFunctor;
template<int RankValue> class IMDRangeFunctor;
template<typename InstanceType> class RangeFunctorT;
template<typename LambdaType> class LambdaRangeFunctorT;
template<typename LambdaType, typename... Views> class LambdaRangeFunctorTVa;
class ForLoopTraceInfo;
class ForLoopRange;
template<int RankValue, typename IndexType_ = Int32> class SimpleForLoopRanges;
template<int RankValue, typename IndexType_ = Int32> class ComplexForLoopRanges;
class ForLoopOneExecStat;
class ForLoopRunInfo;
class ParallelLoopOptions;
 
class TraceInfo;
class StackTrace;
class Exception;
class StackFrame;
class FixedStackFrameArray;
class IStackTraceService;
template <typename T>
class CheckedPointer;
template <class T>
class ReferenceCounterAccessor;
template <typename T>
class ReferenceCounter;
class ReferenceCounterImpl;
class ArgumentException;
class IndexOutOfRangeException;
class FatalErrorException;
class NotSupportedException;
class NotImplementedException;
class TimeoutException;
enum class eBasicDataType : unsigned char;
class IFunctor;
template <typename ArgType>
class IFunctorWithArgumentT;
template <typename ReturnType, typename Arg1, typename Arg2>
class IFunctorWithArgAndReturn2;
template <typename T>
class FunctorT;
template <typename ClassType, typename ArgType>
class FunctorWithArgumentT;
template <typename ArgType>
class StdFunctorWithArgumentT;
class ReferenceCounterImpl;
template <typename InstanceType, class T = void>
struct RefTraits;
template <typename InstanceType, int ImplTagId = RefTraits<InstanceType>::TagId>
class Ref;
 
namespace impl
{
  template <typename InstanceType>
  class ReferenceCounterWrapper;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
// Ces classes sont internes à Arccore/Arcane
template <typename T>
class ArrayRange;
namespace Impl
{
class BasicTranscoder;
template <class DataType> class CoreArray;
class ForLoopStatInfoList;
class ForLoopStatInfoListImpl;
class ForLoopCumulativeStat;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
// Ces classes ne sont pas accessibles dans 'utils' mais il est possible
// d'utiliser des pointeurs sur ces instances.
// La définition est dans 'arcane_accelerator_core'
namespace Accelerator
{
class Runner;
class RunQueue;
}
using Accelerator::Runner;
using Accelerator::RunQueue;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class DefaultLayout;
template<int RankValue> class RightLayoutN;
template<int RankValue> class LeftLayoutN;
template<int RankValue> class MDDimType;
class ConstMemoryView;
class MutableMemoryView;
class IMemoryResourceMng;
// TODO: Rendre obsolète
using IMemoryRessourceMng = IMemoryResourceMng;
template <typename IndexType_ = Int32, Int32... RankSize> class ExtentsV;
template<class DataType,typename Extents,typename LayoutPolicy = DefaultLayout >
class MDSpan;
template<typename DataType,typename Extents,typename LayoutPolicy = DefaultLayout >
using MDSpanBase ARCCORE_DEPRECATED_REASON("Use 'MDSpan' type instead") = MDSpan<DataType,Extents,LayoutPolicy>;
template<typename ExtentType> class ArrayBounds;
 
template<class DataType,typename Extents,typename LayoutType = DefaultLayout >
class NumArray;
template<typename DataType,typename Extents,typename LayoutPolicy = DefaultLayout >
using NumArrayBase ARCCORE_DEPRECATED_REASON("Use 'NumArray' type instead") = NumArray<DataType,Extents,LayoutPolicy>;
 
template<typename Extents,typename LayoutPolicy> class ArrayExtentsWithOffset;
template<int RankValue, typename IndexType_ = Int32> class MDIndexBase;
template<int RankValue, typename IndexType_ = Int32> class MDIndex;
template<int RankValue, typename IndexType_ = Int32> using ArrayIndexBase = MDIndexBase<RankValue,IndexType_>;
template<int RankValue, typename IndexType_ = Int32> using ArrayIndex = MDIndex<RankValue,IndexType_>;
template<int RankValue> using ArrayBoundsIndexBase ARCCORE_DEPRECATED_REASON("Use 'MDIndexBase' type instead") = ArrayIndexBase<RankValue>;
template<int RankValue> using ArrayBoundsIndex ARCCORE_DEPRECATED_REASON("Use 'MDIndex' type instead") = ArrayIndex<RankValue>;
template<typename Extents> class ArrayExtentsBase;
template<typename Extents> class ArrayExtents;
template<int RankValue> class ArrayStridesBase;
template<int RankValue> class IMDRangeFunctor;
template<int RankValue> class ArrayExtentsValueDynamic;
namespace impl
{
template<typename IndexType_, Int32... RankSize> class ArrayExtentsValue;
}
template <typename T, Int32 NbElement>
class FixedArray;
 
class IObservable;
class IObserver;
class Observable;
class Observer;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
//! Equivalent C d'un tableau à une dimension de pointeurs
typedef ArrayView<Pointer> PointerArrayView;
//! Equivalent C d'un tableau à une dimension de caractères
typedef ArrayView<Byte> ByteArrayView;
//! Equivalent C d'un tableau à une dimension de caractères unicode
typedef ArrayView<UChar> UCharArrayView;
//! Equivalent C d'un tableau à une dimension d'entiers 64 bits
typedef ArrayView<Int64> Int64ArrayView;
//! Equivalent C d'un tableau à une dimension d'entiers 32 bits
typedef ArrayView<Int32> Int32ArrayView;
//! Equivalent C d'un tableau à une dimension d'entiers 16 bits
typedef ArrayView<Int16> Int16ArrayView;
//! Equivalent C d'un tableau à une dimension d'entiers
typedef ArrayView<Integer> IntegerArrayView;
//! Equivalent C d'un tableau à une dimension de réels
typedef ArrayView<Real> RealArrayView;
//! Equivalent C d'un tableau à une dimension de booléens
typedef ArrayView<bool> BoolArrayView;
//! Equivalent C d'un tableau à une dimension d'entiers
typedef ArrayView<Integer> IntegerArrayView;
 
//! Equivalent C d'un tableau à une dimension de pointeurs
typedef ConstArrayView<Pointer> PointerConstArrayView;
//! Equivalent C d'un tableau à une dimension de caractères
typedef ConstArrayView<Byte> ByteConstArrayView;
//! Equivalent C d'un tableau à une dimension de caractères unicode
typedef ConstArrayView<UChar> UCharConstArrayView;
//! Equivalent C d'un tableau à une dimension d'entiers 64 bits
typedef ConstArrayView<Int64> Int64ConstArrayView;
//! Equivalent C d'un tableau à une dimension d'entiers 32 bits
typedef ConstArrayView<Int32> Int32ConstArrayView;
//! Equivalent C d'un tableau à une dimension d'entiers 16 bits
typedef ConstArrayView<Int16> Int16ConstArrayView;
//! Equivalent C d'un tableau à une dimension d'entiers
typedef ConstArrayView<Integer> IntegerConstArrayView;
//! Equivalent C d'un tableau à une dimension de réels
typedef ConstArrayView<Real> RealConstArrayView;
//! Equivalent C d'un tableau à une dimension de booléens
typedef ConstArrayView<bool> BoolConstArrayView;
//! Equivalent C d'un tableau à une dimension d'entiers
typedef ConstArrayView<Integer> IntegerConstArrayView;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
//! Equivalent C d'un tableau à une dimension de pointeurs
typedef Span<Pointer> PointerSpan;
//! Equivalent C d'un tableau à une dimension de caractères
typedef Span<std::byte> ByteSpan;
//! Equivalent C d'un tableau à une dimension de caractères unicode
typedef Span<UChar> UCharSpan;
//! Equivalent C d'un tableau à une dimension d'entiers 64 bits
typedef Span<Int64> Int64Span;
//! Equivalent C d'un tableau à une dimension d'entiers 32 bits
typedef Span<Int32> Int32Span;
//! Equivalent C d'un tableau à une dimension d'entiers 16 bits
typedef Span<Int16> Int16Span;
//! Equivalent C d'un tableau à une dimension d'entiers
typedef Span<Integer> IntegerSpan;
//! Equivalent C d'un tableau à une dimension de réels
typedef Span<Real> RealSpan;
//! Equivalent C d'un tableau à une dimension de booléens
typedef Span<bool> BoolSpan;
//! Equivalent C d'un tableau à une dimension d'entiers
typedef Span<Integer> IntegerSpan;
 
//! Equivalent C d'un tableau à une dimension de pointeurs
typedef Span<const Pointer> PointerConstSpan;
//! Equivalent C d'un tableau à une dimension de caractères
typedef Span<const std::byte> ByteConstSpan;
//! Equivalent C d'un tableau à une dimension de caractères unicode
typedef Span<const UChar> UCharConstSpan;
//! Equivalent C d'un tableau à une dimension d'entiers 64 bits
typedef Span<const Int64> Int64ConstSpan;
//! Equivalent C d'un tableau à une dimension d'entiers 32 bits
typedef Span<const Int32> Int32ConstSpan;
//! Equivalent C d'un tableau à une dimension d'entiers 16 bits
typedef Span<const Int16> Int16ConstSpan;
//! Equivalent C d'un tableau à une dimension d'entiers
typedef Span<const Integer> IntegerConstSpan;
//! Equivalent C d'un tableau à une dimension de réels
typedef Span<const Real> RealConstSpan;
//! Equivalent C d'un tableau à une dimension de booléens
typedef Span<const bool> BoolConstSpan;
//! Equivalent C d'un tableau à une dimension d'entiers
typedef Span<const Integer> IntegerConstSpan;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arccore
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arccore
{
using Arcane::Array2View;
using Arcane::Array3View;
using Arcane::Array4View;
using Arcane::ArrayIterator;
using Arcane::ArrayView;
using Arcane::ConstArray2View;
using Arcane::ConstArray3View;
using Arcane::ConstArray4View;
using Arcane::ConstArrayView;
using Arcane::ConstIterT;
using Arcane::eBasicDataType;
using Arcane::IterT;
using Arcane::SmallSpan;
using Arcane::SmallSpan2;
using Arcane::LargeSpan;
using Arcane::Span;
using Arcane::Span2;
using Arcane::Span2Impl;
using Arcane::SpanImpl;
using Arcane::StringImpl;
using Arcane::StringVector;
using Arcane::StringBuilder;
 
using Arcane::TraceInfo;
using Arcane::StackTrace;
using Arcane::Exception;
using Arcane::StackFrame;
using Arcane::FixedStackFrameArray;
using Arcane::IStackTraceService;
using Arcane::CheckedPointer;
using Arcane::ReferenceCounter;
using Arcane::ReferenceCounterImpl;
using Arcane::RefTraits;
using Arcane::Ref;
using Arcane::ArgumentException;
using Arcane::IndexOutOfRangeException;
using Arcane::FatalErrorException;
using Arcane::NotSupportedException;
using Arcane::NotImplementedException;
using Arcane::TimeoutException;
 
using Arcane::IFunctor;
using Arcane::IFunctorWithArgumentT;
using Arcane::IFunctorWithArgAndReturn2;
using Arcane::FunctorT;
using Arcane::FunctorWithArgumentT;
using Arcane::StdFunctorWithArgumentT;
 
using Arcane::Byte;
using Arcane::SByte;
using Arcane::Single;
using Arcane::UChar;
using Arcane::UInt16;
 
using Arcane::PointerArrayView;
using Arcane::ByteArrayView;
using Arcane::UCharArrayView;
using Arcane::Int64ArrayView;
using Arcane::Int32ArrayView;
using Arcane::Int16ArrayView;
using Arcane::IntegerArrayView;
using Arcane::RealArrayView;
using Arcane::BoolArrayView;
using Arcane::IntegerArrayView;
 
using Arcane::PointerConstArrayView;
using Arcane::ByteConstArrayView;
using Arcane::UCharConstArrayView;
using Arcane::Int64ConstArrayView;
using Arcane::Int32ConstArrayView;
using Arcane::Int16ConstArrayView;
using Arcane::IntegerConstArrayView;
using Arcane::RealConstArrayView;
using Arcane::BoolConstArrayView;
using Arcane::IntegerConstArrayView;
 
using Arcane::PointerSpan;
using Arcane::ByteSpan;
using Arcane::UCharSpan;
using Arcane::Int64Span;
using Arcane::Int32Span;
using Arcane::Int16Span;
using Arcane::IntegerSpan;
using Arcane::RealSpan;
using Arcane::BoolSpan;
using Arcane::IntegerSpan;
 
using Arcane::PointerConstSpan;
using Arcane::ByteConstSpan;
using Arcane::UCharConstSpan;
using Arcane::Int64ConstSpan;
using Arcane::Int32ConstSpan;
using Arcane::Int16ConstSpan;
using Arcane::IntegerConstSpan;
using Arcane::RealConstSpan;
using Arcane::BoolConstSpan;
using Arcane::IntegerConstSpan;
 
using Arcane::DynExtent;
 
// Ces classes sont internes à Arccore/Arcane
using Arcane::ArrayRange;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif