LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
lsst::afw::table::FieldBase< Array< U > > Struct Template Reference

Field base class specialization for arrays. More...

#include <FieldBase.h>

Public Types

using Value = ndarray::Array< const U, 1, 1 >
 the type returned by BaseRecord::get More...
 
using Reference = ndarray::ArrayRef< U, 1, 1 >
 the type returned by BaseRecord::operator[] More...
 
using ConstReference = ndarray::ArrayRef< const U, 1, 1 >
 the type returned by BaseRecord::operator[] (const) More...
 
using Element = U
 the type of subfields and array elements More...
 

Public Member Functions

 FieldBase (size_t size=0)
 Construct a FieldBase with the given size. More...
 
 FieldBase (FieldBase const &) noexcept=default
 
 FieldBase (FieldBase &&) noexcept=default
 
FieldBaseoperator= (FieldBase const &) noexcept=default
 
FieldBaseoperator= (FieldBase &&) noexcept=default
 
 ~FieldBase () noexcept=default
 
std::size_t getElementCount () const noexcept
 Return the number of subfield elements (equal to the size of the array), or 0 for a variable-length array. More...
 
std::size_t getSize () const noexcept
 Return the size of the array (equal to the number of subfield elements), or 0 for a variable-length array. More...
 
bool isVariableLength () const noexcept
 Return true if the field is variable-length (each record can have a different size array). More...
 

Static Public Member Functions

static std::string getTypeString ()
 Return a string description of the field type. More...
 

Protected Member Functions

void stream (std::ostream &os) const
 Defines how Fields are printed. More...
 
Reference getReference (Element *p, ndarray::Manager::Ptr const &m) const
 Used to implement BaseRecord::operator[] (non-const). More...
 
ConstReference getConstReference (Element const *p, ndarray::Manager::Ptr const &m) const
 Used to implement BaseRecord::operator[] (const). More...
 
Value getValue (Element const *p, ndarray::Manager::Ptr const &m) const
 Used to implement BaseRecord::get. More...
 
void setValue (Element *p, ndarray::Manager::Ptr const &, ndarray::Array< Element, 1, 1 > const &value) const
 Used to implement BaseRecord::set; accepts only non-const arrays of the right type. More...
 
template<typename Derived >
void setValue (Element *p, ndarray::Manager::Ptr const &, ndarray::ExpressionBase< Derived > const &value) const
 Used to implement BaseRecord::set; accepts any ndarray expression. More...
 

Static Protected Member Functions

static FieldBase makeDefault () noexcept
 Needed to allow Keys to be default-constructed. More...
 

Detailed Description

template<typename U>
struct lsst::afw::table::FieldBase< Array< U > >

Field base class specialization for arrays.

The Array tag is used for both fixed-length (same size in every record, accessible via ColumnView) and variable-length arrays; variable-length arrays are initialized with a size of 0. Ideally, we'd use complete different tag classes for those two very different types, but this was limited in the original (pre-C++11) implementation and now it would be an API change.

Definition at line 96 of file FieldBase.h.

Member Typedef Documentation

◆ ConstReference

template<typename U >
using lsst::afw::table::FieldBase< Array< U > >::ConstReference = ndarray::ArrayRef<const U, 1, 1>

the type returned by BaseRecord::operator[] (const)

Definition at line 103 of file FieldBase.h.

◆ Element

template<typename U >
using lsst::afw::table::FieldBase< Array< U > >::Element = U

the type of subfields and array elements

Definition at line 105 of file FieldBase.h.

◆ Reference

template<typename U >
using lsst::afw::table::FieldBase< Array< U > >::Reference = ndarray::ArrayRef<U, 1, 1>

the type returned by BaseRecord::operator[]

Definition at line 100 of file FieldBase.h.

◆ Value

template<typename U >
using lsst::afw::table::FieldBase< Array< U > >::Value = ndarray::Array<const U, 1, 1>

the type returned by BaseRecord::get

Definition at line 97 of file FieldBase.h.

Constructor & Destructor Documentation

◆ FieldBase() [1/3]

template<typename U >
lsst::afw::table::FieldBase< Array< U > >::FieldBase ( size_t  size = 0)
inline

Construct a FieldBase with the given size.

A size == 0 indicates a variable-length array. Negative sizes are not permitted.

This constructor is implicit with a default so it can be used in the Field constructor (as if it were an int argument) without specializing Field. In other words, it allows one to construct a 25-element array field like this:

Field< Array<float> >("name", "documentation", 25);

...even though the third argument to the Field constructor takes a FieldBase, not an int.

Definition at line 120 of file FieldBase.h.

120  : _size(size) {
121  }

◆ FieldBase() [2/3]

template<typename U >
lsst::afw::table::FieldBase< Array< U > >::FieldBase ( FieldBase< Array< U > > const &  )
defaultnoexcept

◆ FieldBase() [3/3]

template<typename U >
lsst::afw::table::FieldBase< Array< U > >::FieldBase ( FieldBase< Array< U > > &&  )
defaultnoexcept

◆ ~FieldBase()

template<typename U >
lsst::afw::table::FieldBase< Array< U > >::~FieldBase ( )
defaultnoexcept

Member Function Documentation

◆ getConstReference()

template<typename U >
ConstReference lsst::afw::table::FieldBase< Array< U > >::getConstReference ( Element const *  p,
ndarray::Manager::Ptr const &  m 
) const
inlineprotected

Used to implement BaseRecord::operator[] (const).

Definition at line 159 of file FieldBase.h.

159  {
160  if (isVariableLength()) {
161  return reinterpret_cast<ndarray::Array<Element, 1, 1> const *>(p)->deep();
162  }
163  return ndarray::external(p, ndarray::makeVector(_size), ndarray::ROW_MAJOR, m);
164  }
int m
Definition: SpanSet.cc:48
bool isVariableLength() const noexcept
Return true if the field is variable-length (each record can have a different size array).
Definition: FieldBase.h:141

◆ getElementCount()

template<typename U >
std::size_t lsst::afw::table::FieldBase< Array< U > >::getElementCount ( ) const
inlinenoexcept

Return the number of subfield elements (equal to the size of the array), or 0 for a variable-length array.

Definition at line 134 of file FieldBase.h.

134 { return _size; }

◆ getReference()

template<typename U >
Reference lsst::afw::table::FieldBase< Array< U > >::getReference ( Element p,
ndarray::Manager::Ptr const &  m 
) const
inlineprotected

Used to implement BaseRecord::operator[] (non-const).

Definition at line 151 of file FieldBase.h.

151  {
152  if (isVariableLength()) {
153  return reinterpret_cast<ndarray::Array<Element, 1, 1> *>(p)->deep();
154  }
155  return ndarray::external(p, ndarray::makeVector(_size), ndarray::ROW_MAJOR, m);
156  }

◆ getSize()

template<typename U >
std::size_t lsst::afw::table::FieldBase< Array< U > >::getSize ( ) const
inlinenoexcept

Return the size of the array (equal to the number of subfield elements), or 0 for a variable-length array.

Definition at line 138 of file FieldBase.h.

138 { return _size; }

◆ getTypeString()

template<typename U >
std::string lsst::afw::table::FieldBase< Array< U > >::getTypeString
static

Return a string description of the field type.

Definition at line 63 of file FieldBase.cc.

63  {
64  return (boost::format("Array%s") % TypeTraits<U>::getName()).str();
65 }
std::string const & getName() const noexcept
Return a filter's name.
Definition: Filter.h:78
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174

◆ getValue()

template<typename U >
Value lsst::afw::table::FieldBase< Array< U > >::getValue ( Element const *  p,
ndarray::Manager::Ptr const &  m 
) const
inlineprotected

Used to implement BaseRecord::get.

Definition at line 167 of file FieldBase.h.

167  {
168  if (isVariableLength()) {
169  return *reinterpret_cast<ndarray::Array<Element, 1, 1> const *>(p);
170  }
171  return ndarray::external(p, ndarray::makeVector(_size), ndarray::ROW_MAJOR, m);
172  }

◆ isVariableLength()

template<typename U >
bool lsst::afw::table::FieldBase< Array< U > >::isVariableLength ( ) const
inlinenoexcept

Return true if the field is variable-length (each record can have a different size array).

Definition at line 141 of file FieldBase.h.

141 { return _size == 0; }

◆ makeDefault()

template<typename U >
static FieldBase lsst::afw::table::FieldBase< Array< U > >::makeDefault ( )
inlinestaticprotectednoexcept

Needed to allow Keys to be default-constructed.

Definition at line 145 of file FieldBase.h.

145 { return FieldBase(0); }
FieldBase(size_t size=0)
Construct a FieldBase with the given size.
Definition: FieldBase.h:120

◆ operator=() [1/2]

template<typename U >
FieldBase& lsst::afw::table::FieldBase< Array< U > >::operator= ( FieldBase< Array< U > > &&  )
defaultnoexcept

◆ operator=() [2/2]

template<typename U >
FieldBase& lsst::afw::table::FieldBase< Array< U > >::operator= ( FieldBase< Array< U > > const &  )
defaultnoexcept

◆ setValue() [1/2]

template<typename U >
void lsst::afw::table::FieldBase< Array< U > >::setValue ( Element p,
ndarray::Manager::Ptr const &  ,
ndarray::Array< Element, 1, 1 > const &  value 
) const
inlineprotected

Used to implement BaseRecord::set; accepts only non-const arrays of the right type.

Fixed-length arrays are handled by copying the data from value to p through p + _size. Variable-length arrays are handled by setting p to the address of value, an ndarray, hence a shallow copy (ndarray arrays are reference-counted so this will not leak memory). If you want deep assignment of variable-length data, use operator[] to get a reference and assign to that.

Definition at line 180 of file FieldBase.h.

181  {
182  if (isVariableLength()) {
183  *reinterpret_cast<ndarray::Array<Element, 1, 1> *>(p) = value;
184  } else {
185  setValueDeep(p, value);
186  }
187  }

◆ setValue() [2/2]

template<typename U >
template<typename Derived >
void lsst::afw::table::FieldBase< Array< U > >::setValue ( Element p,
ndarray::Manager::Ptr const &  ,
ndarray::ExpressionBase< Derived > const &  value 
) const
inlineprotected

Used to implement BaseRecord::set; accepts any ndarray expression.

Definition at line 191 of file FieldBase.h.

192  {
193  if (isVariableLength()) {
194  throw LSST_EXCEPT(
196  "Assignment to a variable-length array must use a non-const array of the correct type.");
197  }
198  setValueDeep(p, value);
199  }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
Reports errors in the logical structure of the program.
Definition: Runtime.h:46

◆ stream()

template<typename U >
void lsst::afw::table::FieldBase< Array< U > >::stream ( std::ostream os) const
inlineprotected

Defines how Fields are printed.

Definition at line 148 of file FieldBase.h.

148 { os << ", size=" << _size; }
std::ostream * os
Definition: Schema.cc:557

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