Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Experimental::RBitsetField Class Reference

The generic field an std::bitset<N>.

All compilers we care about store the bits in an array of unsigned long. TODO(jblomer): reading and writing efficiency should be improved; currently it is one bit at a time with an array of bools on the page level.

Definition at line 730 of file RField.hxx.

Public Member Functions

 RBitsetField (RBitsetField &&other)=default
 
 RBitsetField (std::string_view fieldName, std::size_t N)
 
 ~RBitsetField () override=default
 
void AcceptVisitor (Detail::RFieldVisitor &visitor) const final
 
Detail::RFieldValue CaptureValue (void *where) final
 Creates a value from a memory location with an already constructed object.
 
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.
 
std::size_t GetN () const
 Get the number of bits in the bitset, i.e. the N in std::bitset<N>
 
size_t GetValueSize () const final
 The number of bytes taken by a value of the appropriate type.
 
RBitsetFieldoperator= (RBitsetField &&other)=default
 
- 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 ()
 
virtual RFieldValue CaptureValue (void *where)=0
 Creates a value from a memory location with an already constructed object.
 
std::unique_ptr< RFieldBaseClone (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_tGetColumnRepresentative () 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()
 
RFieldBaseGetParent () 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
 
std::string GetTypeAlias () 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
 
RFieldBaseoperator= (const RFieldBase &)=delete
 
RFieldBaseoperator= (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< RFieldValueSplitValue (const RFieldValue &value) const
 Creates the list of direct child values given a value for this field.
 

Protected Member Functions

std::size_t AppendImpl (const Detail::RFieldValue &value) final
 Operations on values of complex types, e.g.
 
std::unique_ptr< Detail::RFieldBaseCloneImpl (std::string_view newName) const final
 Called by Clone(), which additionally copies the on-disk ID.
 
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.
 
const RColumnRepresentationsGetColumnRepresentations () const final
 Implementations in derived classes should return a static RColumnRepresentations object.
 
void ReadGlobalImpl (NTupleSize_t globalIndex, Detail::RFieldValue *value) final
 
- Protected Member Functions inherited from ROOT::Experimental::Detail::RFieldBase
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< RFieldBaseCloneImpl (std::string_view newName) const =0
 Called by Clone(), which additionally copies the on-disk ID.
 
const ColumnRepresentation_tEnsureCompatibleColumnTypes (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 RColumnRepresentationsGetColumnRepresentations () 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)
 

Protected Attributes

std::size_t fN
 
- Protected Attributes inherited from ROOT::Experimental::Detail::RFieldBase
const ColumnRepresentation_tfColumnRepresentative = 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()
 
RFieldBasefParent
 Sub fields point to their mother field.
 
RColumnfPrincipalColumn
 Points into fColumns.
 
std::vector< ReadCallback_tfReadCallbacks
 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.
 
std::string fTypeAlias
 A typedef or using name that was used when creating the field.
 

Private Types

using Word_t = unsigned long
 

Static Private Attributes

static constexpr std::size_t kBitsPerWord = kWordSize * 8
 
static constexpr std::size_t kWordSize = sizeof(Word_t)
 

Additional Inherited Members

- Public Types inherited from ROOT::Experimental::Detail::RFieldBase
using ColumnRepresentation_t = std::vector< EColumnType >
 
- 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.
 
- Static Public Attributes inherited from ROOT::Experimental::Detail::RFieldBase
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.
 

#include <ROOT/RField.hxx>

Inheritance diagram for ROOT::Experimental::RBitsetField:
[legend]

Member Typedef Documentation

◆ Word_t

using ROOT::Experimental::RBitsetField::Word_t = unsigned long
private

Definition at line 731 of file RField.hxx.

Constructor & Destructor Documentation

◆ RBitsetField() [1/2]

ROOT::Experimental::RBitsetField::RBitsetField ( std::string_view  fieldName,
std::size_t  N 
)

Definition at line 2172 of file RField.cxx.

◆ RBitsetField() [2/2]

ROOT::Experimental::RBitsetField::RBitsetField ( RBitsetField &&  other)
default

◆ ~RBitsetField()

ROOT::Experimental::RBitsetField::~RBitsetField ( )
overridedefault

Member Function Documentation

◆ AcceptVisitor()

void ROOT::Experimental::RBitsetField::AcceptVisitor ( Detail::RFieldVisitor visitor) const
finalvirtual

Reimplemented from ROOT::Experimental::Detail::RFieldBase.

Definition at line 2226 of file RField.cxx.

◆ AppendImpl()

std::size_t ROOT::Experimental::RBitsetField::AppendImpl ( const Detail::RFieldValue value)
finalprotectedvirtual

Operations on values of complex types, e.g.

ones that involve multiple columns or for which no direct column type exists.

Reimplemented from ROOT::Experimental::Detail::RFieldBase.

Definition at line 2198 of file RField.cxx.

◆ CaptureValue()

Detail::RFieldValue ROOT::Experimental::RBitsetField::CaptureValue ( void *  where)
inlinefinalvirtual

Creates a value from a memory location with an already constructed object.

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 761 of file RField.hxx.

◆ CloneImpl()

std::unique_ptr< Detail::RFieldBase > ROOT::Experimental::RBitsetField::CloneImpl ( std::string_view  newName) const
inlinefinalprotectedvirtual

Called by Clone(), which additionally copies the on-disk ID.

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 739 of file RField.hxx.

◆ GenerateColumnsImpl() [1/2]

void ROOT::Experimental::RBitsetField::GenerateColumnsImpl ( )
finalprotectedvirtual

Creates the backing columns corresponsing to the field type for writing.

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 2187 of file RField.cxx.

◆ GenerateColumnsImpl() [2/2]

void ROOT::Experimental::RBitsetField::GenerateColumnsImpl ( const RNTupleDescriptor desc)
finalprotectedvirtual

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 2192 of file RField.cxx.

◆ GenerateValue()

Detail::RFieldValue ROOT::Experimental::RBitsetField::GenerateValue ( void *  where)
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 756 of file RField.hxx.

◆ GetAlignment()

size_t ROOT::Experimental::RBitsetField::GetAlignment ( ) const
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 766 of file RField.hxx.

◆ GetColumnRepresentations()

const ROOT::Experimental::Detail::RFieldBase::RColumnRepresentations & ROOT::Experimental::RBitsetField::GetColumnRepresentations ( ) const
finalprotectedvirtual

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 2181 of file RField.cxx.

◆ GetN()

std::size_t ROOT::Experimental::RBitsetField::GetN ( ) const
inline

Get the number of bits in the bitset, i.e. the N in std::bitset<N>

Definition at line 770 of file RField.hxx.

◆ GetValueSize()

size_t ROOT::Experimental::RBitsetField::GetValueSize ( ) const
inlinefinalvirtual

The number of bytes taken by a value of the appropriate type.

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 765 of file RField.hxx.

◆ operator=()

RBitsetField & ROOT::Experimental::RBitsetField::operator= ( RBitsetField &&  other)
default

◆ ReadGlobalImpl()

void ROOT::Experimental::RBitsetField::ReadGlobalImpl ( NTupleSize_t  globalIndex,
Detail::RFieldValue value 
)
finalprotectedvirtual

Reimplemented from ROOT::Experimental::Detail::RFieldBase.

Definition at line 2213 of file RField.cxx.

Member Data Documentation

◆ fN

std::size_t ROOT::Experimental::RBitsetField::fN
protected

Definition at line 736 of file RField.hxx.

◆ kBitsPerWord

constexpr std::size_t ROOT::Experimental::RBitsetField::kBitsPerWord = kWordSize * 8
staticconstexprprivate

Definition at line 733 of file RField.hxx.

◆ kWordSize

constexpr std::size_t ROOT::Experimental::RBitsetField::kWordSize = sizeof(Word_t)
staticconstexprprivate

Definition at line 732 of file RField.hxx.

Libraries for ROOT::Experimental::RBitsetField:

The documentation for this class was generated from the following files: