An artificial field that transforms an RNTuple column that contains the offset of collections into collection sizes.
It is used to provide the "number of" RDF columns for collections, e.g. R_rdf_sizeof_jets
for a collection named jets
.
This field owns the collection offset field but instead of exposing the collection offsets it exposes the collection sizes (offset(N+1) - offset(N)). For the time being, we offer this functionality only in RDataFrame. TODO(jblomer): consider providing a general set of useful virtual fields as part of RNTuple.
Definition at line 59 of file RNTupleDS.cxx.
Public Member Functions | |
RRDFCardinalityField () | |
RRDFCardinalityField (RRDFCardinalityField &&other)=default | |
~RRDFCardinalityField ()=default | |
ROOT::Experimental::Detail::RFieldValue | CaptureValue (void *where) final |
Creates a value from a memory location with an already constructed object. | |
void | GenerateColumnsImpl () final |
Creates the backing columns corresponsing to the field type for writing. | |
void | GenerateColumnsImpl (const RNTupleDescriptor &desc) final |
Creates the backing columns corresponsing to the field type for reading. | |
ROOT::Experimental::Detail::RFieldValue | GenerateValue (void *where) final |
Generates a tree value in a given location of size at least GetValueSize(). | |
size_t | GetAlignment () const final |
As a rule of thumb, the alignment is equal to the size of the type. | |
const RColumnRepresentations & | GetColumnRepresentations () const final |
Implementations in derived classes should return a static RColumnRepresentations object. | |
size_t | GetValueSize () const final |
The number of bytes taken by a value of the appropriate type. | |
RRDFCardinalityField & | operator= (RRDFCardinalityField &&other)=default |
void | ReadGlobalImpl (ROOT::Experimental::NTupleSize_t globalIndex, ROOT::Experimental::Detail::RFieldValue *value) final |
Get the number of elements of the collection identified by globalIndex. | |
void | ReadInClusterImpl (const ROOT::Experimental::RClusterIndex &clusterIndex, ROOT::Experimental::Detail::RFieldValue *value) final |
Get the number of elements of the collection identified by clusterIndex. | |
![]() | |
RFieldBase (const RFieldBase &)=delete | |
RFieldBase (RFieldBase &&)=default | |
RFieldBase (std::string_view name, std::string_view type, ENTupleStructure structure, bool isSimple, std::size_t nRepetitions=0) | |
The constructor creates the underlying column objects and connects them to either a sink or a source. | |
virtual | ~RFieldBase () |
virtual void | AcceptVisitor (RFieldVisitor &visitor) const |
std::size_t | Append (const RFieldValue &value) |
Write the given value into columns. | |
void | Attach (std::unique_ptr< Detail::RFieldBase > child) |
Add a new subfield to the list of nested fields. | |
RSchemaIterator | begin () |
virtual RFieldValue | CaptureValue (void *where)=0 |
Creates a value from a memory location with an already constructed object. | |
std::unique_ptr< RFieldBase > | Clone (std::string_view newName) const |
Copies the field and its sub fields using a possibly new name and a new, unconnected set of columns. | |
virtual void | CommitCluster () |
Perform housekeeping tasks for global to cluster-local index translation. | |
void | ConnectPageSink (RPageSink &pageSink) |
Fields and their columns live in the void until connected to a physical page storage. | |
void | ConnectPageSource (RPageSource &pageSource) |
virtual void | DestroyValue (const RFieldValue &value, bool dtorOnly=false) |
Releases the resources acquired during GenerateValue (memory and constructor) This implementation works for simple types but needs to be overwritten for complex ones. | |
RSchemaIterator | end () |
void | Flush () const |
Ensure that all received items are written from page buffers to the storage. | |
RFieldValue | GenerateValue () |
Generates an object of the field type and allocates new initialized memory according to the type. | |
virtual RFieldValue | GenerateValue (void *where)=0 |
Generates a tree value in a given location of size at least GetValueSize(). | |
virtual size_t | GetAlignment () const =0 |
As a rule of thumb, the alignment is equal to the size of the type. | |
const ColumnRepresentation_t & | GetColumnRepresentative () const |
Returns the fColumnRepresentative pointee or, if unset, the field's default representative. | |
std::string | GetDescription () const |
Get the field's description. | |
virtual std::uint32_t | GetFieldVersion () const |
Indicates an evolution of the mapping scheme from C++ type to columns. | |
std::string | GetName () const |
NTupleSize_t | GetNElements () const |
std::size_t | GetNRepetitions () const |
DescriptorId_t | GetOnDiskId () const |
std::uint32_t | GetOnDiskTypeVersion () const |
Return the C++ type version stored in the field descriptor; only valid after a call to ConnectPageSource() | |
RFieldBase * | GetParent () const |
std::string | GetQualifiedFieldName () const |
Returns the field name and parent field names separated by dots ("grandparent.parent.child") | |
ENTupleStructure | GetStructure () const |
std::vector< RFieldBase * > | GetSubFields () const |
int | GetTraits () const |
std::string | GetType () const |
virtual std::uint32_t | GetTypeVersion () const |
Indicates an evolution of the C++ type itself. | |
virtual size_t | GetValueSize () const =0 |
The number of bytes taken by a value of the appropriate type. | |
bool | HasDefaultColumnRepresentative () const |
Whether or not an explicit column representative was set. | |
bool | HasReadCallbacks () const |
bool | IsSimple () const |
RFieldBase & | operator= (const RFieldBase &)=delete |
RFieldBase & | operator= (RFieldBase &&)=default |
void | Read (const RClusterIndex &clusterIndex, RFieldValue *value) |
void | Read (NTupleSize_t globalIndex, RFieldValue *value) |
Populate a single value with data from the tree, which needs to be of the fitting type. | |
void | SetColumnRepresentative (const ColumnRepresentation_t &representative) |
Fixes a column representative. | |
void | SetDescription (std::string_view description) |
void | SetOnDiskId (DescriptorId_t id) |
virtual std::vector< RFieldValue > | SplitValue (const RFieldValue &value) const |
Creates the list of direct child values given a value for this field. | |
Static Public Member Functions | |
static std::string | TypeName () |
![]() | |
static RResult< std::unique_ptr< RFieldBase > > | Create (const std::string &fieldName, const std::string &typeName) |
Factory method to resurrect a field from the stored on-disk type information. | |
static RResult< void > | EnsureValidFieldName (std::string_view fieldName) |
Check whether a given string is a valid field name. | |
Protected Member Functions | |
std::unique_ptr< ROOT::Experimental::Detail::RFieldBase > | CloneImpl (std::string_view) const final |
Called by Clone(), which additionally copies the on-disk ID. | |
![]() | |
size_t | AddReadCallback (ReadCallback_t func) |
Set a user-defined function to be called after reading a value, giving a chance to inspect and/or modify the value object. | |
virtual std::size_t | AppendImpl (const RFieldValue &value) |
Operations on values of complex types, e.g. | |
void | AutoAdjustColumnTypes (const RNTupleWriteOptions &options) |
When connecting a field to a page sink, the field's default column representation is subject to adjustment according to the write options. | |
virtual std::unique_ptr< RFieldBase > | CloneImpl (std::string_view newName) const =0 |
Called by Clone(), which additionally copies the on-disk ID. | |
const ColumnRepresentation_t & | EnsureCompatibleColumnTypes (const RNTupleDescriptor &desc) const |
Returns the on-disk column types found in the provided descriptor for fOnDiskId. | |
virtual void | GenerateColumnsImpl ()=0 |
Creates the backing columns corresponsing to the field type for writing. | |
virtual void | GenerateColumnsImpl (const RNTupleDescriptor &desc)=0 |
Creates the backing columns corresponsing to the field type for reading. | |
virtual const RColumnRepresentations & | GetColumnRepresentations () const |
Implementations in derived classes should return a static RColumnRepresentations object. | |
virtual void | OnConnectPageSource () |
Called by ConnectPageSource() only once connected; derived classes may override this as appropriate. | |
virtual void | ReadGlobalImpl (NTupleSize_t globalIndex, RFieldValue *value) |
virtual void | ReadInClusterImpl (const RClusterIndex &clusterIndex, RFieldValue *value) |
void | RemoveReadCallback (size_t idx) |
Additional Inherited Members | |
![]() | |
using | ColumnRepresentation_t = std::vector< EColumnType > |
![]() | |
static constexpr std::uint32_t | kInvalidTypeVersion = -1U |
static constexpr int | kTraitMappable = 0x04 |
A field of a fundamental type that can be directly mapped via RField<T>::Map() , i.e. | |
static constexpr int | kTraitTriviallyConstructible = 0x01 |
No constructor needs to be called, i.e. | |
static constexpr int | kTraitTriviallyDestructible = 0x02 |
The type is cleaned up just by freeing its memory. I.e. DestroyValue() is a no-op. | |
static constexpr int | kTraitTrivialType = kTraitTriviallyConstructible | kTraitTriviallyDestructible |
Shorthand for types that are both trivially constructible and destructible. | |
![]() | |
const ColumnRepresentation_t * | fColumnRepresentative = nullptr |
Points into the static vector GetColumnRepresentations().GetSerializationTypes() when SetColumnRepresentative is called. | |
std::vector< std::unique_ptr< RColumn > > | fColumns |
The columns are connected either to a sink or to a source (not to both); they are owned by the field. | |
std::uint32_t | fOnDiskTypeVersion = kInvalidTypeVersion |
C++ type version cached from the descriptor after a call to ConnectPageSource() | |
RFieldBase * | fParent |
Sub fields point to their mother field. | |
RColumn * | fPrincipalColumn |
Points into fColumns. | |
std::vector< ReadCallback_t > | fReadCallbacks |
List of functions to be called after reading a value. | |
std::vector< std::unique_ptr< RFieldBase > > | fSubFields |
Collections and classes own sub fields. | |
int | fTraits = 0 |
Properties of the type that allow for optimizations of collections of that type. | |
|
inline |
Definition at line 68 of file RNTupleDS.cxx.
|
default |
|
default |
|
inlinefinalvirtual |
Creates a value from a memory location with an already constructed object.
Implements ROOT::Experimental::Detail::RFieldBase.
Definition at line 94 of file RNTupleDS.cxx.
|
inlinefinalprotectedvirtual |
Called by Clone(), which additionally copies the on-disk ID.
Implements ROOT::Experimental::Detail::RFieldBase.
Definition at line 61 of file RNTupleDS.cxx.
|
inlinefinalvirtual |
Creates the backing columns corresponsing to the field type for writing.
Implements ROOT::Experimental::Detail::RFieldBase.
Definition at line 82 of file RNTupleDS.cxx.
|
inlinefinalvirtual |
Creates the backing columns corresponsing to the field type for reading.
The method should to check, using the page source and fOnDiskId, if the column types match and throw if they don't.
Implements ROOT::Experimental::Detail::RFieldBase.
Definition at line 83 of file RNTupleDS.cxx.
|
inlinefinalvirtual |
Generates a tree value in a given location of size at least GetValueSize().
Assumes that where has been allocated by malloc().
Implements ROOT::Experimental::Detail::RFieldBase.
Definition at line 90 of file RNTupleDS.cxx.
|
inlinefinalvirtual |
As a rule of thumb, the alignment is equal to the size of the type.
There are, however, various exceptions to this rule depending on OS and CPU architecture. So enforce the alignment to be explicitly spelled out.
Implements ROOT::Experimental::Detail::RFieldBase.
Definition at line 99 of file RNTupleDS.cxx.
|
inlinefinalvirtual |
Implementations in derived classes should return a static RColumnRepresentations object.
The default implementation does not attach any columns to the field.
Reimplemented from ROOT::Experimental::Detail::RFieldBase.
Definition at line 74 of file RNTupleDS.cxx.
|
inlinefinalvirtual |
The number of bytes taken by a value of the appropriate type.
Implements ROOT::Experimental::Detail::RFieldBase.
Definition at line 98 of file RNTupleDS.cxx.
|
default |
|
inlinefinalvirtual |
Get the number of elements of the collection identified by globalIndex.
Reimplemented from ROOT::Experimental::Detail::RFieldBase.
Definition at line 103 of file RNTupleDS.cxx.
|
inlinefinalvirtual |
Get the number of elements of the collection identified by clusterIndex.
Reimplemented from ROOT::Experimental::Detail::RFieldBase.
Definition at line 112 of file RNTupleDS.cxx.
|
inlinestatic |
Definition at line 67 of file RNTupleDS.cxx.