71std::unique_ptr<ROOT::RFieldBase>
75 const auto &typeName = GetTypeAlias().empty() ? GetTypeName() : GetTypeAlias();
76 auto streamerField = std::make_unique<ROOT::RStreamerField>(GetFieldName(), typeName);
85 auto invalidField = std::make_unique<ROOT::RInvalidField>(GetFieldName(), GetTypeName(),
"",
90 throw RException(
R__FAIL(
"unexpected on-disk field structure value for field \"" + GetFieldName() +
"\""));
95 if (GetTypeName().empty()) {
96 switch (GetStructure()) {
98 std::vector<std::unique_ptr<ROOT::RFieldBase>>
memberFields;
100 for (
auto id : fLinkIds) {
112 if (fLinkIds.size() != 1) {
113 throw RException(
R__FAIL(
"unsupported untyped collection for field \"" + GetFieldName() +
"\""));
122 default:
throw RException(
R__FAIL(
"unsupported untyped field structure for field \"" + GetFieldName() +
"\""));
128 const auto &typeName = GetTypeAlias().empty() ? GetTypeName() : GetTypeAlias();
133 field->SetOnDiskId(fFieldId);
148 return std::make_unique<ROOT::RInvalidField>(GetFieldName(), GetTypeName(),
ex.GetError().GetReport(),
161 if (fTypeName.empty())
165 if (fTypeName.compare(0, 10,
"std::pair<") == 0)
167 if (fTypeName.compare(0, 11,
"std::tuple<") == 0)
188 return fLogicalColumnId ==
other.fLogicalColumnId && fPhysicalColumnId ==
other.fPhysicalColumnId &&
189 fBitsOnStorage ==
other.fBitsOnStorage && fType ==
other.fType && fFieldId ==
other.fFieldId &&
190 fIndex ==
other.fIndex && fRepresentationIndex ==
other.fRepresentationIndex &&
191 fValueRange ==
other.fValueRange;
214 if (!fCumulativeNElements) {
218 for (
const auto &pi : fPageInfos) {
228 const auto N = fCumulativeNElements->size();
232 std::size_t left = 0;
233 std::size_t right =
N - 1;
235 while (left <= right) {
265 std::accumulate(fPageInfos.begin(), fPageInfos.end(), 0U,
266 [](std::size_t
n,
const auto &
pageInfo) { return n + pageInfo.GetNElements(); });
289 std::make_move_iterator(fPageInfos.end()));
296 return fClusterId ==
other.fClusterId && fFirstEntryIndex ==
other.fFirstEntryIndex &&
297 fNEntries ==
other.fNEntries && fColumnRanges ==
other.fColumnRanges && fPageRanges ==
other.fPageRanges;
303 for (
const auto &
pr : fPageRanges) {
304 for (
const auto &pi :
pr.second.GetPageInfos()) {
305 nbytes += pi.GetLocator().GetNBytesOnStorage();
318 for (
const auto &
d : fPageRanges)
327 return fContentId ==
other.fContentId && fTypeName ==
other.fTypeName && fTypeVersion ==
other.fTypeVersion;
350 return fName ==
other.fName &&
351 fDescription ==
other.fDescription &&
352 fNEntries ==
other.fNEntries &&
353 fGeneration ==
other.fGeneration &&
354 fFieldZeroId ==
other.fFieldZeroId &&
355 fFieldDescriptors ==
other.fFieldDescriptors &&
356 fColumnDescriptors ==
other.fColumnDescriptors &&
357 fClusterGroupDescriptors ==
other.fClusterGroupDescriptors &&
358 fClusterDescriptors ==
other.fClusterDescriptors;
365 for (
const auto &cd : fClusterDescriptors) {
376std::vector<ROOT::Internal::RNTupleClusterBoundaries>
379 std::vector<Internal::RNTupleClusterBoundaries> boundaries;
397 if (
posDot != std::string::npos) {
427 return fVersionMajor == 0 && fVersionMinor == 0 && fVersionPatch < 1;
432 std::string typeName =
fieldDesc.GetTypeName();
434 if (FieldTypeNamesMayNeedFixup()) {
443 return FindFieldId(
fieldName, GetFieldZeroId());
451 if (
itr == fFieldDescriptors.cend())
456 if (
itr->second.GetLogicalColumnIds().size() <= idx)
458 return itr->second.GetLogicalColumnIds()[idx];
468 return GetColumnDescriptor(
logicalId).GetPhysicalId();
474 if (GetNClusterGroups() == 0)
480 std::size_t
cgRight = GetNClusterGroups() - 1;
483 const auto &
clusterIds = GetClusterGroupDescriptor(fSortedClusterGroupIds[
cgMidpoint]).GetClusterIds();
536 if (GetNClusterGroups() == 0)
542 std::size_t
cgRight = GetNClusterGroups() - 1;
545 const auto &
cgDesc = GetClusterGroupDescriptor(fSortedClusterGroupIds[
cgMidpoint]);
606 return FindClusterId(
clusterDesc.GetFirstEntryIndex() - 1);
609std::vector<ROOT::DescriptorId_t>
612 std::vector<ROOT::DescriptorId_t>
fields;
613 for (
const auto fieldId : fFieldIdsOrder) {
622 : fNTuple(
ntuple), fColumns(
field.GetLogicalColumnIds())
647 std::vector<std::uint64_t>
result;
648 unsigned int base = 0;
649 std::uint64_t flags = 0;
651 if ((
f > 0) && ((
f % 64) == 0))
653 while (
f > base + 64) {
654 result.emplace_back(flags);
659 flags |= std::uint64_t(1) <<
f;
661 result.emplace_back(flags);
670 return R__FAIL(
"invalid attempt to add details of unknown cluster group");
671 if (iter->second.HasClusterDetails())
672 return R__FAIL(
"invalid attempt to re-populate cluster group details");
674 return R__FAIL(
"mismatch of number of clusters");
681 return R__FAIL(
"invalid attempt to re-populate existing cluster");
685 return fClusterDescriptors[a].GetFirstEntryIndex() < fClusterDescriptors[b].GetFirstEntryIndex();
689 iter->second =
cgBuilder.MoveDescriptor().Unwrap();
697 return R__FAIL(
"invalid attempt to drop cluster details of unknown cluster group");
698 if (!iter->second.HasClusterDetails())
699 return R__FAIL(
"invalid attempt to drop details of cluster group summary");
701 for (
auto clusterId : iter->second.GetClusterIds())
703 iter->second = iter->second.CloneSummary();
731 "cannot create Model: descriptor contains unknown column types. Use 'SetForwardCompatible(true)' on the "
732 "RCreateModelOptions to create a partial model containing only the fields made up by known columns."));
734 auto fieldZero = std::make_unique<ROOT::RFieldZero>();
755 const auto cat =
invalid.GetCategory();
765 model->AddProjectedField(std::move(
field), [
this](
const std::string &
targetName) -> std::string {
769 model->AddField(std::move(
field));
801 std::vector<ROOT::DescriptorId_t>
toVisit;
845 return fClusterGroupId ==
other.fClusterGroupId && fClusterIds ==
other.fClusterIds &&
877 return R__FAIL(
"column ID mismatch");
878 if (fCluster.fColumnRanges.count(
physicalId) > 0)
879 return R__FAIL(
"column ID conflict");
881 for (
const auto &pi :
pageRange.fPageInfos) {
892 if (fCluster.fColumnRanges.count(
physicalId) > 0)
893 return R__FAIL(
"column ID conflict");
931 return R__FAIL(std::string(
"cannot find non-suppressed column for column ID ") +
932 std::to_string(
columnRange.GetPhysicalColumnId()) +
933 ", cluster ID: " + std::to_string(fCluster.GetId()));
964 for (const auto &c : desc.GetColumnIterable(fieldId)) {
965 const ROOT::DescriptorId_t physicalId = c.GetPhysicalId();
966 auto &columnRange = fCluster.fColumnRanges[physicalId];
971 if (columnRange.GetPhysicalColumnId() == ROOT::kInvalidDescriptorId) {
972 columnRange.SetPhysicalColumnId(physicalId);
973 columnRange.SetFirstElementIndex(0);
974 columnRange.SetNElements(0);
975 columnRange.SetIsSuppressed(c.IsSuppressedDeferredColumn());
983 if (c.IsDeferredColumn()) {
984 if (c.GetRepresentationIndex() == 0) {
985 columnRange.SetFirstElementIndex(fCluster.GetFirstEntryIndex() * nRepetitions);
986 columnRange.SetNElements(fCluster.GetNEntries() * nRepetitions);
993 const auto &field = desc.GetFieldDescriptor(fieldId);
994 const auto firstReprColumnId = field.GetLogicalColumnIds()[c.GetIndex()];
995 const auto &firstReprColumnRange = fCluster.fColumnRanges[firstReprColumnId];
996 columnRange.SetFirstElementIndex(firstReprColumnRange.GetFirstElementIndex());
997 columnRange.SetNElements(firstReprColumnRange.GetNElements());
999 if (!columnRange.IsSuppressed()) {
1000 auto &pageRange = fCluster.fPageRanges[physicalId];
1001 pageRange.fPhysicalColumnId = physicalId;
1002 const auto element = ROOT::Internal::RColumnElementBase::Generate<void>(c.GetType());
1003 pageRange.ExtendToFitColumnRange(columnRange, *element, ROOT::Internal::RPage::kPageZeroSize);
1005 } else if (!columnRange.IsSuppressed()) {
1006 fCluster.fPageRanges[physicalId].fPhysicalColumnId = physicalId;
1018 return R__FAIL(
"unset cluster ID");
1019 if (fCluster.fNEntries == 0)
1020 return R__FAIL(
"empty cluster");
1021 for (
auto &
pr : fCluster.fPageRanges) {
1022 if (fCluster.fColumnRanges.count(
pr.first) == 0) {
1023 return R__FAIL(
"missing column range");
1025 pr.second.fCumulativeNElements.reset();
1026 const auto nPages =
pr.second.fPageInfos.size();
1028 pr.second.fCumulativeNElements = std::make_unique<std::vector<NTupleSize_t>>();
1029 pr.second.fCumulativeNElements->reserve(
nPages);
1031 for (
const auto &pi :
pr.second.fPageInfos) {
1032 sum += pi.GetNElements();
1033 pr.second.fCumulativeNElements->emplace_back(
sum);
1038 std::swap(
result, fCluster);
1060 return R__FAIL(
"unset cluster group ID");
1062 std::swap(
result, fClusterGroup);
1073 std::swap(
result, fExtraTypeInfo);
1081 if (fDescriptor.fFieldDescriptors.count(
fieldId) == 0)
1082 return R__FAIL(
"field with id '" + std::to_string(
fieldId) +
"' doesn't exist");
1089 return R__FAIL(
"unset or unsupported RNTuple epoch version");
1101 return R__FAIL(
"field with id '" + std::to_string(
fieldId) +
"' has an invalid parent id");
1119 return R__FAIL(
"field with id '" + std::to_string(
fieldId) +
"' has incomplete column representations");
1127 EnsureValidDescriptor().ThrowOnError();
1129 for (
const auto &[
id,
_] : fDescriptor.fClusterGroupDescriptors)
1130 fDescriptor.fSortedClusterGroupIds.emplace_back(
id);
1131 std::sort(fDescriptor.fSortedClusterGroupIds.begin(), fDescriptor.fSortedClusterGroupIds.end(),
1133 return fDescriptor.fClusterGroupDescriptors[a].GetMinEntry() <
1134 fDescriptor.fClusterGroupDescriptors[b].GetMinEntry();
1137 std::swap(
result, fDescriptor);
1164 fDescriptor.fName = std::string(
name);
1165 fDescriptor.fDescription = std::string(
description);
1172 fDescriptor.fFeatureFlags.insert(
flag);
1178 if (fDesc.fName.empty())
1179 return R__FAIL(
"attribute set name cannot be empty");
1180 if (fDesc.fAnchorLength == 0)
1181 return R__FAIL(
"invalid anchor length");
1183 return R__FAIL(
"invalid locator type");
1185 return std::move(fDesc);
1191 return R__FAIL(
"invalid logical column id");
1193 return R__FAIL(
"invalid physical column id");
1195 return R__FAIL(
"invalid field id, dangling column");
1204 if (fColumn.GetBitsOnStorage() <
minBits || fColumn.GetBitsOnStorage() >
maxBits)
1205 return R__FAIL(
"invalid column bit width");
1208 return fColumn.Clone();
1216 .TypeVersion(
field.GetTypeVersion())
1217 .FieldName(
field.GetFieldName())
1218 .FieldDescription(
field.GetDescription())
1219 .TypeName(
field.GetTypeName())
1220 .TypeAlias(
field.GetTypeAlias())
1221 .Structure(
field.GetStructure())
1222 .NRepetitions(
field.GetNRepetitions());
1235 return R__FAIL(
"invalid field id");
1238 return R__FAIL(
"invalid field structure");
1241 return R__FAIL(
"invalid SoA flag on non-collection field");
1249 if (fField.GetFieldName().empty()) {
1250 return R__FAIL(
"name cannot be empty string \"\"");
1253 return fField.Clone();
1259 if (fDescriptor.fHeaderExtension)
1260 fDescriptor.fHeaderExtension->MarkExtendedField(
fieldDesc);
1262 fDescriptor.fFieldZeroId =
fieldDesc.GetId();
1273 return R__FAIL(
"child field with id '" + std::to_string(
linkId) +
"' doesn't exist in NTuple");
1275 if (
linkId == fDescriptor.GetFieldZeroId()) {
1276 return R__FAIL(
"cannot make FieldZero a child field");
1279 auto parentId = fDescriptor.fFieldDescriptors.at(
linkId).GetParentId();
1281 return R__FAIL(
"field '" + std::to_string(
linkId) +
"' already has a parent ('" + std::to_string(
parentId) +
")");
1284 return R__FAIL(
"cannot make field '" + std::to_string(
fieldId) +
"' a child of itself");
1286 fDescriptor.fFieldDescriptors.at(
linkId).fParentId =
fieldId;
1287 fDescriptor.fFieldDescriptors.at(
fieldId).fLinkIds.push_back(
linkId);
1298 return R__FAIL(
"projected field with id '" + std::to_string(
targetId) +
"' doesn't exist in NTuple");
1300 if (
targetId == fDescriptor.GetFieldZeroId()) {
1301 return R__FAIL(
"cannot make FieldZero a projected field");
1304 return R__FAIL(
"cannot make field '" + std::to_string(
targetId) +
"' a projection of itself");
1306 if (fDescriptor.fFieldDescriptors.at(
sourceId).IsProjectedField()) {
1307 return R__FAIL(
"cannot make field '" + std::to_string(
targetId) +
"' a projection of an already projected field");
1312 return R__FAIL(
"field '" + std::to_string(
targetId) +
"' has already a projection source ('" +
1313 std::to_string(
targetDesc.GetProjectionSourceId()) +
")");
1332 if (
columnDesc.GetType() != fDescriptor.GetColumnDescriptor(
columnDesc.GetPhysicalId()).GetType())
1333 return R__FAIL(
"alias column type mismatch");
1336 return R__FAIL(
"column index clash");
1340 return R__FAIL(
"out of bounds column index");
1344 return R__FAIL(
"out of bounds representation index");
1350 return R__FAIL(
"incomplete column representations");
1354 return R__FAIL(
"irregular column representations");
1365 fDescriptor.fNPhysicalColumns++;
1367 if (fDescriptor.fHeaderExtension)
1368 fDescriptor.fHeaderExtension->MarkExtendedColumn(
columnDesc);
1376 if (fDescriptor.fClusterGroupDescriptors.count(
id) > 0)
1377 return R__FAIL(
"cluster group id clash");
1380 fDescriptor.fClusterGroupDescriptors.emplace(
id, std::move(
clusterGroup));
1391 if (!fDescriptor.fHeaderExtension)
1392 fDescriptor.fHeaderExtension = std::make_unique<RNTupleDescriptor::RHeaderExtension>();
1397 if (fDescriptor.GetNLogicalColumns() == 0)
1399 R__ASSERT(fDescriptor.GetNPhysicalColumns() > 0);
1401 for (
ROOT::DescriptorId_t id = fDescriptor.GetNLogicalColumns() - 1;
id >= fDescriptor.GetNPhysicalColumns(); --
id) {
1402 auto c = fDescriptor.fColumnDescriptors[
id].Clone();
1405 fDescriptor.fColumnDescriptors.erase(
id);
1406 for (
auto &
link : fDescriptor.fFieldDescriptors[
c.fFieldId].fLogicalColumnIds) {
1407 if (
link ==
c.fLogicalColumnId) {
1413 R__ASSERT(fDescriptor.fColumnDescriptors.count(
c.fLogicalColumnId) == 0);
1414 fDescriptor.fColumnDescriptors.emplace(
c.fLogicalColumnId, std::move(
c));
1418 if (
auto &
xHeader = fDescriptor.fHeaderExtension) {
1420 if (
columnId >= fDescriptor.GetNPhysicalColumns())
1429 if (fDescriptor.fClusterDescriptors.count(
clusterId) > 0)
1430 return R__FAIL(
"cluster id clash");
1439 if (std::find(fDescriptor.fExtraTypeInfoDescriptors.begin(), fDescriptor.fExtraTypeInfoDescriptors.end(),
1441 return R__FAIL(
"extra type info duplicates");
1443 fDescriptor.fExtraTypeInfoDescriptors.emplace_back(std::move(
extraTypeInfoDesc));
1449 auto it = std::find(fDescriptor.fExtraTypeInfoDescriptors.begin(), fDescriptor.fExtraTypeInfoDescriptors.end(),
1451 if (it != fDescriptor.fExtraTypeInfoDescriptors.end())
1454 fDescriptor.fExtraTypeInfoDescriptors.emplace_back(std::move(
extraTypeInfoDesc));
1460 auto &
attrSets = fDescriptor.fAttributeSets;
1462 return desc.GetName() == name;
1464 return R__FAIL(
"attribute sets with duplicate names");
1551 return fAnchorLength ==
other.fAnchorLength && fSchemaVersionMajor ==
other.fSchemaVersionMajor &&
1552 fSchemaVersionMinor ==
other.fSchemaVersionMinor && fAnchorLocator ==
other.fAnchorLocator &&
1571 if (
fieldDesc.GetTypeName().rfind(
"std::", 0) == 0)
1578 static const std::string
gIntTypeNames[] = {
"bool",
"char",
"std::int8_t",
"std::uint8_t",
1579 "std::int16_t",
"std::uint16_t",
"std::int32_t",
"std::uint32_t",
1580 "std::int64_t",
"std::uint64_t"};
1589 return (
fieldDesc.GetTypeName().rfind(
"std::atomic<", 0) == 0);
#define R__FORWARD_ERROR(res)
Short-hand to return an RResult<T> in an error state (i.e. after checking)
#define R__FAIL(msg)
Short-hand to return an RResult<T> in an error state; the RError is implicitly converted into RResult...
ROOT::Detail::TRangeCast< T, true > TRangeDynCast
TRangeDynCast is an adapter class that allows the typed iteration through a TCollection.
#define R__ASSERT(e)
Checks condition e and reports a fatal error if it's false.
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h offset
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t result
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t index
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize id
RResult< ROOT::Experimental::RNTupleAttrSetDescriptor > MoveDescriptor()
Attempt to make an AttributeSet descriptor.
Used to loop over all the Attribute Sets linked to an RNTuple.
Metadata stored for every Attribute Set linked to an RNTuple.
bool operator==(const RNTupleAttrSetDescriptor &other) const
std::uint16_t fSchemaVersionMajor
RNTupleAttrSetDescriptor Clone() const
std::uint32_t fAnchorLength
uncompressed size of the linked anchor
RNTupleLocator fAnchorLocator
std::uint16_t fSchemaVersionMinor
A helper class for piece-wise construction of an RClusterDescriptor.
RResult< void > MarkSuppressedColumnRange(ROOT::DescriptorId_t physicalId)
Books the given column ID as being suppressed in this cluster.
RResult< void > CommitColumnRange(ROOT::DescriptorId_t physicalId, std::uint64_t firstElementIndex, std::uint32_t compressionSettings, const RClusterDescriptor::RPageRange &pageRange)
RClusterDescriptorBuilder & AddExtendedColumnRanges(const RNTupleDescriptor &desc)
Add column and page ranges for columns created during late model extension missing in this cluster.
RResult< void > CommitSuppressedColumnRanges(const RNTupleDescriptor &desc)
Sets the first element index and number of elements for all the suppressed column ranges.
RResult< RClusterDescriptor > MoveDescriptor()
Move out the full cluster descriptor including page locations.
A helper class for piece-wise construction of an RClusterGroupDescriptor.
RClusterGroupDescriptorBuilder & EntrySpan(std::uint64_t entrySpan)
RClusterGroupDescriptorBuilder & PageListLocator(const RNTupleLocator &pageListLocator)
static RClusterGroupDescriptorBuilder FromSummary(const RClusterGroupDescriptor &clusterGroupDesc)
RClusterGroupDescriptorBuilder & PageListLength(std::uint64_t pageListLength)
RClusterGroupDescriptorBuilder & MinEntry(std::uint64_t minEntry)
RResult< RClusterGroupDescriptor > MoveDescriptor()
RClusterGroupDescriptorBuilder & ClusterGroupId(ROOT::DescriptorId_t clusterGroupId)
RClusterGroupDescriptorBuilder & NClusters(std::uint32_t nClusters)
RResult< RColumnDescriptor > MakeDescriptor() const
Attempt to make a column descriptor.
A column element encapsulates the translation between basic C++ types and their column representation...
static std::pair< std::uint16_t, std::uint16_t > GetValidBitRange(ROOT::ENTupleColumnType type)
Most types have a fixed on-disk bit width.
A helper class for piece-wise construction of an RFieldDescriptor.
RResult< RFieldDescriptor > MakeDescriptor() const
Attempt to make a field descriptor.
static RFieldDescriptorBuilder FromField(const ROOT::RFieldBase &field)
Make a new RFieldDescriptorBuilder based off a live RNTuple field.
void SetNTuple(const std::string_view name, const std::string_view description)
void SetSchemaFromExisting(const RNTupleDescriptor &descriptor)
Copies the "schema" part of descriptor into the builder's descriptor.
void SetVersionForWriting()
RResult< void > AddColumn(RColumnDescriptor &&columnDesc)
RResult< void > AddAttributeSet(Experimental::RNTupleAttrSetDescriptor &&attrSetDesc)
RResult< void > AddFieldProjection(ROOT::DescriptorId_t sourceId, ROOT::DescriptorId_t targetId)
void ReplaceExtraTypeInfo(RExtraTypeInfoDescriptor &&extraTypeInfoDesc)
RResult< void > AddExtraTypeInfo(RExtraTypeInfoDescriptor &&extraTypeInfoDesc)
void ShiftAliasColumns(std::uint32_t offset)
Shift column IDs of alias columns by offset
void SetVersion(std::uint16_t versionEpoch, std::uint16_t versionMajor, std::uint16_t versionMinor, std::uint16_t versionPatch)
RNTupleDescriptor MoveDescriptor()
void BeginHeaderExtension()
Mark the beginning of the header extension; any fields and columns added after a call to this functio...
RResult< void > AddCluster(RClusterDescriptor &&clusterDesc)
RResult< void > EnsureValidDescriptor() const
Checks whether invariants hold:
RResult< void > AddFieldLink(ROOT::DescriptorId_t fieldId, ROOT::DescriptorId_t linkId)
void AddField(const RFieldDescriptor &fieldDesc)
RResult< void > AddClusterGroup(RClusterGroupDescriptor &&clusterGroup)
RResult< void > EnsureFieldExists(ROOT::DescriptorId_t fieldId) const
void SetFeature(unsigned int flag)
A helper class for serializing and deserialization of the RNTuple binary format.
The window of element indexes of a particular column in a particular cluster.
Metadata for RNTuple clusters.
ROOT::NTupleSize_t fFirstEntryIndex
Clusters can be swapped by adjusting the entry offsets of the cluster and all ranges.
std::unordered_map< ROOT::DescriptorId_t, RColumnRange > fColumnRanges
ROOT::NTupleSize_t fNEntries
ROOT::DescriptorId_t fClusterId
RClusterDescriptor Clone() const
bool operator==(const RClusterDescriptor &other) const
RColumnRangeIterable GetColumnRangeIterable() const
Returns an iterator over pairs { columnId, columnRange }. The iteration order is unspecified.
std::unordered_map< ROOT::DescriptorId_t, RPageRange > fPageRanges
std::uint64_t GetNBytesOnStorage() const
Clusters are bundled in cluster groups.
RNTupleLocator fPageListLocator
The page list that corresponds to the cluster group.
RClusterGroupDescriptor Clone() const
std::vector< ROOT::DescriptorId_t > fClusterIds
The cluster IDs can be empty if the corresponding page list is not loaded.
std::uint64_t fMinEntry
The minimum first entry number of the clusters in the cluster group.
std::uint32_t fNClusters
Number of clusters is always known even if the cluster IDs are not (yet) populated.
std::uint64_t fPageListLength
Uncompressed size of the page list.
ROOT::DescriptorId_t fClusterGroupId
std::uint64_t fEntrySpan
Number of entries that are (partially for sharded clusters) covered by this cluster group.
bool operator==(const RClusterGroupDescriptor &other) const
RClusterGroupDescriptor CloneSummary() const
Creates a clone without the cluster IDs.
Metadata stored for every column of an RNTuple.
ROOT::DescriptorId_t fPhysicalColumnId
Usually identical to the logical column ID, except for alias columns where it references the shadowed...
bool operator==(const RColumnDescriptor &other) const
ROOT::DescriptorId_t fLogicalColumnId
The actual column identifier, which is the link to the corresponding field.
ROOT::DescriptorId_t fFieldId
Every column belongs to one and only one field.
std::int64_t fFirstElementIndex
The absolute value specifies the index for the first stored element for this column.
std::uint32_t fIndex
A field can be serialized into several columns, which are numbered from zero to $n$.
std::uint16_t fBitsOnStorage
The size in bits of elements of this column.
std::uint16_t fRepresentationIndex
A field may use multiple column representations, which are numbered from zero to $m$.
ROOT::ENTupleColumnType fType
The on-disk column type.
std::optional< RValueRange > fValueRange
Optional value range (used e.g. by quantized real fields)
RColumnDescriptor Clone() const
Get a copy of the descriptor.
Base class for all ROOT issued exceptions.
A field translates read and write calls from/to underlying columns to/from tree values.
@ kTraitSoACollection
The field represents a collection in SoA layout.
@ kTraitInvalidField
This field is an instance of RInvalidField and can be safely static_cast to it.
@ kTraitTypeChecksum
The TClass checksum is set and valid.
Metadata stored for every field of an RNTuple.
std::unique_ptr< ROOT::RFieldBase > CreateField(const RNTupleDescriptor &ntplDesc, const ROOT::RCreateFieldOptions &options={}) const
In general, we create a field simply from the C++ type name.
std::uint32_t fFieldVersion
The version of the C++-type-to-column translation mechanics.
ROOT::DescriptorId_t fFieldId
RFieldDescriptor Clone() const
Get a copy of the descriptor.
std::uint64_t fNRepetitions
The number of elements per entry for fixed-size arrays.
std::uint32_t fColumnCardinality
The number of columns in the column representations of the field.
ROOT::DescriptorId_t fProjectionSourceId
For projected fields, the source field ID.
bool IsCustomEnum(const RNTupleDescriptor &desc) const R__DEPRECATED(6
bool operator==(const RFieldDescriptor &other) const
bool IsCustomClass() const R__DEPRECATED(6
bool IsStdAtomic() const R__DEPRECATED(6
std::string fFieldDescription
Free text set by the user.
ROOT::DescriptorId_t fParentId
Establishes sub field relationships, such as classes and collections.
std::string fTypeAlias
A typedef or using directive that resolved to the type name during field creation.
ROOT::ENTupleStructure fStructure
The structural information carried by this field in the data model tree.
std::vector< ROOT::DescriptorId_t > fLinkIds
The pointers in the other direction from parent to children.
std::string fFieldName
The leaf name, not including parent fields.
bool fIsSoACollection
Indicates if this is a collection that should be represented in memory by a SoA layout.
std::uint32_t fTypeVersion
The version of the C++ type itself.
std::string fTypeName
The C++ type that was used when writing the field.
std::vector< ROOT::DescriptorId_t > fLogicalColumnIds
The ordered list of columns attached to this field: first by representation index then by column inde...
std::optional< std::uint32_t > fTypeChecksum
For custom classes, we store the ROOT TClass reported checksum to facilitate the use of I/O rules tha...
Used in RFieldBase::Check() to record field creation failures.
@ kGeneric
Generic unrecoverable error.
@ kUnknownStructure
The field could not be created because its descriptor had an unknown structural role.
Used to loop over all the clusters of an RNTuple (in unspecified order)
Used to loop over all the cluster groups of an RNTuple (in unspecified order)
Used to loop over a field's associated columns.
std::vector< ROOT::DescriptorId_t > fColumns
The descriptor ids of the columns ordered by field, representation, and column index.
RColumnDescriptorIterable(const RNTupleDescriptor &ntuple, const RFieldDescriptor &fieldDesc)
Used to loop over a field's child fields.
The on-storage metadata of an RNTuple.
const RColumnDescriptor & GetColumnDescriptor(ROOT::DescriptorId_t columnId) const
ROOT::DescriptorId_t FindNextClusterId(ROOT::DescriptorId_t clusterId) const
RFieldDescriptorIterable GetFieldIterable(const RFieldDescriptor &fieldDesc) const
std::set< unsigned int > fFeatureFlags
std::unordered_map< ROOT::DescriptorId_t, RClusterGroupDescriptor > fClusterGroupDescriptors
const RFieldDescriptor & GetFieldDescriptor(ROOT::DescriptorId_t fieldId) const
std::uint64_t fNPhysicalColumns
Updated by the descriptor builder when columns are added.
std::vector< Experimental::RNTupleAttrSetDescriptor > fAttributeSets
List of AttributeSets linked to this RNTuple.
ROOT::DescriptorId_t fFieldZeroId
Set by the descriptor builder.
std::uint64_t fNEntries
Updated by the descriptor builder when the cluster groups are added.
RClusterGroupDescriptorIterable GetClusterGroupIterable() const
RColumnDescriptorIterable GetColumnIterable() const
bool operator==(const RNTupleDescriptor &other) const
std::uint64_t fOnDiskFooterSize
Like fOnDiskHeaderSize, contains both cluster summaries and page locations.
std::uint16_t fVersionMinor
Set by the descriptor builder when deserialized.
ROOT::DescriptorId_t FindClusterId(ROOT::NTupleSize_t entryIdx) const
std::vector< std::uint64_t > GetFeatureFlags() const
ROOT::DescriptorId_t GetFieldZeroId() const
Returns the logical parent of all top-level RNTuple data fields.
std::unique_ptr< ROOT::RNTupleModel > CreateModel(const RCreateModelOptions &options=RCreateModelOptions()) const
Re-create the C++ model from the stored metadata.
std::string GetTypeNameForComparison(const RFieldDescriptor &fieldDesc) const
Adjust the type name of the passed RFieldDescriptor for comparison with another renormalized type nam...
std::unordered_map< ROOT::DescriptorId_t, RClusterDescriptor > fClusterDescriptors
Potentially a subset of all the available clusters.
std::size_t GetNClusters() const
ROOT::DescriptorId_t FindPhysicalColumnId(ROOT::DescriptorId_t fieldId, std::uint32_t columnIndex, std::uint16_t representationIndex) const
RExtraTypeInfoDescriptorIterable GetExtraTypeInfoIterable() const
const RHeaderExtension * GetHeaderExtension() const
Return header extension information; if the descriptor does not have a header extension,...
std::uint64_t fNClusters
Updated by the descriptor builder when the cluster groups are added.
std::uint64_t fOnDiskHeaderXxHash3
Set by the descriptor builder when deserialized.
const RClusterDescriptor & GetClusterDescriptor(ROOT::DescriptorId_t clusterId) const
ROOT::DescriptorId_t FindFieldId(std::string_view fieldName, ROOT::DescriptorId_t parentId) const
std::string fName
The RNTuple name needs to be unique in a given storage location (file)
std::uint64_t fOnDiskHeaderSize
Set by the descriptor builder when deserialized.
RResult< void > DropClusterGroupDetails(ROOT::DescriptorId_t clusterGroupId)
std::uint16_t fVersionMajor
Set by the descriptor builder when deserialized.
std::vector< ROOT::DescriptorId_t > fSortedClusterGroupIds
References cluster groups sorted by entry range and thus allows for binary search.
std::unordered_map< ROOT::DescriptorId_t, RColumnDescriptor > fColumnDescriptors
ROOT::DescriptorId_t FindLogicalColumnId(ROOT::DescriptorId_t fieldId, std::uint32_t columnIndex, std::uint16_t representationIndex) const
std::unordered_map< ROOT::DescriptorId_t, RFieldDescriptor > fFieldDescriptors
ROOT::NTupleSize_t GetNElements(ROOT::DescriptorId_t physicalColumnId) const
RResult< void > AddClusterGroupDetails(ROOT::DescriptorId_t clusterGroupId, std::vector< RClusterDescriptor > &clusterDescs)
Methods to load and drop cluster group details (cluster IDs and page locations)
std::uint16_t fVersionPatch
Set by the descriptor builder when deserialized.
std::string fDescription
Free text from the user.
ROOT::Experimental::RNTupleAttrSetDescriptorIterable GetAttrSetIterable() const
RFieldDescriptorIterable GetTopLevelFields() const
std::uint16_t fVersionEpoch
Set by the descriptor builder when deserialized.
std::vector< RExtraTypeInfoDescriptor > fExtraTypeInfoDescriptors
RNTupleDescriptor Clone() const
std::string GetQualifiedFieldName(ROOT::DescriptorId_t fieldId) const
Walks up the parents of the field ID and returns a field name of the form a.b.c.d In case of invalid ...
bool FieldTypeNamesMayNeedFixup() const
ROOT v6.34, with spec versions before 1.0.0.1, did not properly renormalize the type name.
RClusterDescriptorIterable GetClusterIterable() const
RNTupleDescriptor CloneSchema() const
Creates a descriptor containing only the schema information about this RNTuple, i....
std::uint64_t fGeneration
The generation of the descriptor.
ROOT::DescriptorId_t FindPrevClusterId(ROOT::DescriptorId_t clusterId) const
std::unique_ptr< RHeaderExtension > fHeaderExtension
Generic information about the physical location of data.
static std::unique_ptr< RNTupleModel > Create()
static std::unique_ptr< RNTupleModel > CreateBare()
Creates a "bare model", i.e. an RNTupleModel with no default entry.
static constexpr std::uint16_t kVersionPatch
static constexpr std::uint16_t kVersionMajor
static constexpr std::uint16_t kVersionEpoch
static constexpr std::uint16_t kVersionMinor
const_iterator begin() const
const_iterator end() const
The class is used as a return type for operations that can fail; wraps a value of type T or an RError...
static std::unique_ptr< RVectorField > CreateUntyped(std::string_view fieldName, std::unique_ptr< RFieldBase > itemField)
ROOT::DescriptorId_t CallFindClusterIdOn(const ROOT::RNTupleDescriptor &desc, ROOT::NTupleSize_t entryIdx)
RResult< void > EnsureValidNameForRNTuple(std::string_view name, std::string_view where)
Check whether a given string is a valid name according to the RNTuple specification.
ROOT::RResult< std::unique_ptr< ROOT::RFieldBase > > CallFieldBaseCreate(const std::string &fieldName, const std::string &typeName, const ROOT::RCreateFieldOptions &options, const ROOT::RNTupleDescriptor *desc, ROOT::DescriptorId_t fieldId)
void FixupFieldTypeName(ROOT::RFieldDescriptor &fieldDesc)
bool IsCustomEnumFieldDesc(const RNTupleDescriptor &desc, const RFieldDescriptor &fieldDesc)
Tells if the field describes a user-defined enum type.
std::vector< ROOT::Internal::RNTupleClusterBoundaries > GetClusterBoundaries(const RNTupleDescriptor &desc)
Return the cluster boundaries for each cluster in this RNTuple.
std::string GetRenormalizedTypeName(const std::string &metaNormalizedName)
Given a type name normalized by ROOT meta, renormalize it for RNTuple. E.g., insert std::prefix.
bool IsStdAtomicFieldDesc(const RFieldDescriptor &fieldDesc)
Tells if the field describes a std::atomic<T> type.
std::uint64_t DescriptorId_t
Distriniguishes elements of the same type within a descriptor, e.g. different fields.
constexpr NTupleSize_t kInvalidNTupleIndex
std::uint64_t NTupleSize_t
Integer type long enough to hold the maximum number of entries in a column.
constexpr DescriptorId_t kInvalidDescriptorId
Additional information about a page in an in-memory RPageRange.
Information about a single page in the context of a cluster's page range.
bool GetReturnInvalidOnError() const
Modifiers passed to CreateModel()
bool GetCreateBare() const
bool GetEmulateUnknownTypes() const
bool GetReconstructProjections() const
bool GetForwardCompatible() const
static uint64_t sum(uint64_t i)