SheafSystem  0.0.0.0
sheaf::dof_descriptor_array Class Reference

An array for storing structs which describe the size, alignment, and offset of dofs within a dof tuple. More...

#include <dof_descriptor_array.h>

Classes

class  dof_descriptor
 Basic description of a dof. More...
 

Public Member Functions

 dof_descriptor_array (size_type xdof_ct)
 Create array for descriptors of xdof_dofs. More...
 
 ~dof_descriptor_array ()
 Destructor. More...
 
virtual dof_descriptoroperator[] (int xid) const
 Value of xid-th element. More...
 
void add_reference ()
 Add a reference to this. More...
 
void remove_reference ()
 Remove a reference from this. More...
 
size_type ub () const
 The upper bound on the array index; the number of descriptors. Note that this is not the number of dofs described in this array. More...
 
size_type dof_ct () const
 The number of dofs described in this. More...
 
size_type size () const
 The number of bytes in the dof tuple described by this. More...
 

Detailed Description

An array for storing structs which describe the size, alignment, and offset of dofs within a dof tuple.

Definition at line 50 of file dof_descriptor_array.h.

Constructor & Destructor Documentation

◆ dof_descriptor_array()

sheaf::dof_descriptor_array::dof_descriptor_array ( size_type  xdof_ct)

Create array for descriptors of xdof_dofs.

Precondition
  • xdof_ct >= 0
Postcondition
  • ub() == xdof_ct + 1

Definition at line 32 of file dof_descriptor_array.cc.

References ub(), and ~dof_descriptor_array().

◆ ~dof_descriptor_array()

sheaf::dof_descriptor_array::~dof_descriptor_array ( )

Destructor.

Definition at line 54 of file dof_descriptor_array.cc.

References operator[]().

Referenced by dof_descriptor_array().

Member Function Documentation

◆ add_reference()

◆ dof_ct()

sheaf::size_type sheaf::dof_descriptor_array::dof_ct ( ) const

The number of dofs described in this.

Postcondition
  • result >= 0

Definition at line 110 of file dof_descriptor_array.cc.

References size().

Referenced by ub().

◆ operator[]()

sheaf::dof_descriptor_array::dof_descriptor & sheaf::dof_descriptor_array::operator[] ( int  xid) const
virtual

Value of xid-th element.

Precondition
  • (0 <= xid) && (xid < ub())

Definition at line 71 of file dof_descriptor_array.cc.

References add_reference(), and ub().

Referenced by ~dof_descriptor_array().

◆ remove_reference()

◆ size()

sheaf::size_type sheaf::dof_descriptor_array::size ( ) const

The number of bytes in the dof tuple described by this.

Definition at line 123 of file dof_descriptor_array.cc.

References sheaf::operator<<().

Referenced by dof_ct(), and sheaf::primitives_poset_schema::schematize().

◆ ub()

sheaf::size_type sheaf::dof_descriptor_array::ub ( ) const

The upper bound on the array index; the number of descriptors. Note that this is not the number of dofs described in this array.

Postcondition
  • result >= 1

Definition at line 97 of file dof_descriptor_array.cc.

References dof_ct().

Referenced by sheaf::deep_size(), dof_descriptor_array(), sheaf::operator<<(), operator[](), and remove_reference().


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