RNTupleUtil.hxx File Reference

#include <cstdint>
#include <string>
#include <string_view>
#include <variant>
#include <ROOT/RError.hxx>
#include <ROOT/RLogger.hxx>
#include <ROOT/RNTupleReadOptions.hxx>

Include dependency graph for RNTupleUtil.hxx:

This graph shows which files directly or indirectly include this file:

Classes
class	ROOT::Experimental::RClusterIndex
	Addresses a column element or field item relative to a particular cluster, instead of a global NTupleSize_t index. More...
struct	ROOT::Experimental::RClusterSize
	Wrap the integer in a struct in order to avoid template specialization clash with std::uint64_t. More...
class	ROOT::Experimental::RColumnSwitch
	Holds the index and the tag of a kSwitch column. More...
struct	ROOT::RNTupleCardinality< SizeT >
	Helper types to present an offset column as array of collection sizes. More...
struct	ROOT::Experimental::RNTupleLocator
	Generic information about the physical location of data. More...
struct	ROOT::Experimental::RNTupleLocatorObject64
	RNTupleLocator payload that is common for object stores using 64bit location information. More...
struct	ROOT::Experimental::RNTupleOpenSpec
	Used to specify the underlying RNTuples in RNTupleProcessor and RNTupleReader::OpenFriends() More...

Namespaces
namespace	ROOT
	tbb::task_arena is an alias of tbb::interface7::task_arena, which doesn't allow to forward declare tbb::task_arena without forward declaring tbb::interface7
namespace	ROOT::Experimental
namespace	ROOT::Experimental::Internal

Typedefs
using	ROOT::Experimental::ClusterSize_t = RClusterSize
using	ROOT::Experimental::ColumnId_t = std::int64_t
	Uniquely identifies a physical column within the scope of the current process, used to tag pages.
using	ROOT::Experimental::DescriptorId_t = std::uint64_t
	Distriniguishes elements of the same type within a descriptor, e.g. different fields.
using	ROOT::Experimental::NTupleSize_t = std::uint64_t
	Integer type long enough to hold the maximum number of entries in a column.

Enumerations
enum class	ROOT::Experimental::EColumnType {   ROOT::Experimental::kUnknown = 0 , ROOT::Experimental::kIndex64 , ROOT::Experimental::kIndex32 , ROOT::Experimental::kSwitch ,   ROOT::Experimental::kByte , ROOT::Experimental::kChar , ROOT::Experimental::kBit , ROOT::Experimental::kReal64 ,   ROOT::Experimental::kReal32 , ROOT::Experimental::kReal16 , ROOT::Experimental::kInt64 , ROOT::Experimental::kUInt64 ,   ROOT::Experimental::kInt32 , ROOT::Experimental::kUInt32 , ROOT::Experimental::kInt16 , ROOT::Experimental::kUInt16 ,   ROOT::Experimental::kInt8 , ROOT::Experimental::kUInt8 , ROOT::Experimental::kSplitIndex64 , ROOT::Experimental::kSplitIndex32 ,   ROOT::Experimental::kSplitReal64 , ROOT::Experimental::kSplitReal32 , ROOT::Experimental::kSplitInt64 , ROOT::Experimental::kSplitUInt64 ,   ROOT::Experimental::kSplitInt32 , ROOT::Experimental::kSplitUInt32 , ROOT::Experimental::kSplitInt16 , ROOT::Experimental::kSplitUInt16 ,   ROOT::Experimental::kReal32Trunc , ROOT::Experimental::kReal32Quant , ROOT::Experimental::kMax }
enum	ROOT::Experimental::ENTupleStructure : std::uint16_t {   ROOT::Experimental::kInvalid , ROOT::Experimental::kLeaf , ROOT::Experimental::kCollection , ROOT::Experimental::kRecord ,   ROOT::Experimental::kVariant , ROOT::Experimental::kStreamer , ROOT::Experimental::kUnknown }
	The fields in the ntuple model tree can carry different structural information about the type system. More...

Functions
RResult< void >	ROOT::Experimental::Internal::EnsureValidNameForRNTuple (std::string_view name, std::string_view where)
	Check whether a given string is a valid name according to the RNTuple specification.
constexpr ClusterSize_t	ROOT::Experimental::kInvalidClusterIndex (std::uint64_t(-1))
template<typename T >
auto	ROOT::Experimental::Internal::MakeAliasedSharedPtr (T *rawPtr)
RLogChannel &	ROOT::Experimental::NTupleLog ()
	Log channel for RNTuple diagnostics.

Variables
constexpr ColumnId_t	ROOT::Experimental::kInvalidColumnId = -1
constexpr DescriptorId_t	ROOT::Experimental::kInvalidDescriptorId = std::uint64_t(-1)
constexpr NTupleSize_t	ROOT::Experimental::kInvalidNTupleIndex = std::uint64_t(-1)
constexpr ENTupleStructure	ROOT::Experimental::Internal::kTestFutureFieldStructure
constexpr RNTupleLocator::ELocatorType	ROOT::Experimental::Internal::kTestLocatorType = static_cast<RNTupleLocator::ELocatorType>(0x7e)
constexpr int	ROOT::Experimental::kUnknownCompressionSettings = -1

Detailed Description

Author

Jakob Blomer jblom.nosp@m.er@c.nosp@m.ern.c.nosp@m.h

Date

2018-10-04

Warning

This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!

Definition in file RNTupleUtil.hxx.