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 44 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 &) 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 | 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. | |
Public Member Functions inherited from ROOT::Experimental::Detail::RFieldBase | |
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 () |
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 size_t | GetAlignment () const |
For many types, the alignment requirement is equal to the size; otherwise override. | |
std::string | GetDescription () const |
Get the field's description. | |
virtual RNTupleVersion | 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 |
RFieldBase * | GetParent () const |
ENTupleStructure | GetStructure () const |
std::vector< RFieldBase * > | GetSubFields () const |
std::string | GetType () const |
virtual RNTupleVersion | GetTypeVersion () const |
Indicates an evolution of the C++ type itself. | |
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 | 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 Public Member Functions inherited from ROOT::Experimental::Detail::RFieldBase | |
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. | |
Protected Member Functions inherited from ROOT::Experimental::Detail::RFieldBase | |
virtual std::size_t | AppendImpl (const RFieldValue &value) |
Operations on values of complex types, e.g. | |
ROOT::Experimental::EColumnType | EnsureColumnType (const std::vector< EColumnType > &requestedTypes, unsigned int columnIndex, const RNTupleDescriptor &desc) |
Throws an exception if the column given by fOnDiskId and the columnIndex in the provided descriptor is not of one of the requested types. | |
Additional Inherited Members | |
Protected Attributes inherited from ROOT::Experimental::Detail::RFieldBase | |
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. | |
RFieldBase * | fParent |
Sub fields point to their mother field. | |
RColumn * | fPrincipalColumn |
Points into fColumns. | |
std::vector< std::unique_ptr< RFieldBase > > | fSubFields |
Collections and classes own sub fields. | |
|
inline |
Definition at line 53 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 74 of file RNTupleDS.cxx.
|
inlinefinalprotectedvirtual |
Called by Clone(), which additionally copies the on-disk ID.
Implements ROOT::Experimental::Detail::RFieldBase.
Definition at line 46 of file RNTupleDS.cxx.
|
inlinefinalvirtual |
Creates the backing columns corresponsing to the field type for writing.
Implements ROOT::Experimental::Detail::RFieldBase.
Definition at line 60 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 62 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 70 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 78 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 82 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 91 of file RNTupleDS.cxx.
|
inlinestatic |
Definition at line 52 of file RNTupleDS.cxx.