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
Flag.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 #ifndef LSST_AFW_TABLE_Flag_h_INCLUDED
3 #define LSST_AFW_TABLE_Flag_h_INCLUDED
4 
5 #include <cstdint>
6 
8 
9 #include "lsst/afw/table/misc.h"
11 #include "lsst/afw/table/KeyBase.h"
12 
13 namespace lsst {
14 namespace afw {
15 namespace table {
16 
17 namespace detail {
18 
19 class Access;
20 
21 } // namespace detail
22 
32 template <>
33 struct FieldBase<Flag> {
34  using Value = bool;
36 
38  std::size_t getElementCount() const { return 1; }
39 
41  static std::string getTypeString() { return "Flag"; }
42 
43  // Only the first of these constructors is valid for this specializations, but
44  // it's convenient to be able to instantiate both, since the other is used
45  // by other specializations.
46  FieldBase() = default;
49  "Constructor disabled (this Field type is not sized).");
50  }
51 
52  FieldBase(FieldBase const &) = default;
53  FieldBase(FieldBase &&) = default;
54  FieldBase &operator=(FieldBase const &) = default;
55  FieldBase &operator=(FieldBase &&) = default;
56  ~FieldBase() = default;
57 
58 protected:
60  void stream(std::ostream &os) const {}
61 };
62 
66 template <>
67 class KeyBase<Flag> {
68 public:
69  static bool const HAS_NAMED_SUBFIELDS = false;
70 
72  Key<FieldBase<Flag>::Element> getStorage() const;
73 
74  KeyBase() = default;
75  KeyBase(KeyBase const &) = default;
76  KeyBase(KeyBase &&) = default;
77  KeyBase &operator=(KeyBase const &) = default;
78  KeyBase &operator=(KeyBase &&) = default;
79  ~KeyBase() = default;
80 };
81 
93 template <>
94 class Key<Flag> : public KeyBase<Flag>, public FieldBase<Flag> {
95 public:
97 
106  template <typename OtherT>
107  bool operator==(Key<OtherT> const &other) const {
108  return false;
109  }
110  template <typename OtherT>
111  bool operator!=(Key<OtherT> const &other) const {
112  return true;
113  }
114 
115  bool operator==(Key const &other) const { return _offset == other._offset && _bit == other._bit; }
116  bool operator!=(Key const &other) const { return !this->operator==(other); }
118 
120  std::size_t hash_value() const noexcept {
121  // Completely arbitrary seed
122  return utils::hashCombine(17, _offset, _bit);
123  }
124 
126  std::size_t getOffset() const { return _offset; }
127 
129  std::size_t getBit() const { return _bit; }
130 
139  bool isValid() const { return _valid; }
140 
146  Key() : FieldBase<Flag>(), _offset(0), _bit(0), _valid(false) {}
147 
148  Key(Key const &) = default;
149  Key(Key &&) = default;
150  Key &operator=(Key const &) = default;
151  Key &operator=(Key &&) = default;
152  ~Key() = default;
153 
155  inline friend std::ostream &operator<<(std::ostream &os, Key<Flag> const &key) {
156  return os << "Key['" << Key<Flag>::getTypeString() << "'](offset=" << key.getOffset()
157  << ", bit=" << key.getBit() << ")";
158  }
159 
160 private:
161  friend class detail::Access;
162  friend class BaseRecord;
163 
165  Value getValue(Element const *p, ndarray::Manager::Ptr const &) const {
166  return (*p) & (Element(1) << _bit);
167  }
168 
170  void setValue(Element *p, ndarray::Manager::Ptr const &, Value v) const {
171  if (v) {
172  *p |= (Element(1) << _bit);
173  } else {
174  *p &= ~(Element(1) << _bit);
175  }
176  }
177 
178  explicit Key(std::size_t offset, std::size_t bit) : _offset(offset), _bit(bit), _valid(true) {}
179 
180  std::size_t _offset;
181  std::size_t _bit;
182  bool _valid;
183 };
184 } // namespace table
185 } // namespace afw
186 } // namespace lsst
187 
188 namespace std {
189 template <>
190 struct hash<lsst::afw::table::Key<lsst::afw::table::Flag>> {
193  size_t operator()(argument_type const &obj) const noexcept { return obj.hash_value(); }
194 };
195 } // namespace std
196 
197 #endif // !LSST_AFW_TABLE_Flag_h_INCLUDED
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
std::ostream * os
Definition: Schema.cc:557
Base class for all records.
Definition: BaseRecord.h:31
Key specialization for Flag.
Definition: Flag.h:94
bool isValid() const
Return true if the key was initialized to valid offset.
Definition: Flag.h:139
Key(Key const &)=default
bool operator==(Key< OtherT > const &other) const
Equality comparison.
Definition: Flag.h:107
std::size_t getBit() const
The index of this field's bit within the integer it shares with other Flag fields.
Definition: Flag.h:129
Key()
Default construct a field.
Definition: Flag.h:146
bool operator==(Key const &other) const
Definition: Flag.h:115
Key & operator=(Key &&)=default
bool operator!=(Key< OtherT > const &other) const
Definition: Flag.h:111
bool operator!=(Key const &other) const
Definition: Flag.h:116
std::size_t getOffset() const
Return the offset in bytes of the integer element that holds this field's bit.
Definition: Flag.h:126
Key & operator=(Key const &)=default
std::size_t hash_value() const noexcept
Return a hash of this object.
Definition: Flag.h:120
friend std::ostream & operator<<(std::ostream &os, Key< Flag > const &key)
Stringification.
Definition: Flag.h:155
KeyBase(KeyBase const &)=default
KeyBase & operator=(KeyBase &&)=default
KeyBase & operator=(KeyBase const &)=default
A base class for Key that allows subfield keys to be extracted for some field types.
Definition: KeyBase.h:20
static bool const HAS_NAMED_SUBFIELDS
Definition: KeyBase.h:22
A class used as a handle to a particular field in a table.
Definition: Key.h:53
bool operator==(Key< OtherT > const &other) const noexcept
Equality comparison.
Definition: Key.h:66
Key() noexcept
Default construct a field.
Definition: Key.h:104
Reports errors in the logical structure of the program.
Definition: Runtime.h:46
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition: hashCombine.h:35
A base class for image defects.
STL namespace.
FieldBase & operator=(FieldBase const &)=default
std::size_t getElementCount() const
Return the number of subfield elements (always one for scalars).
Definition: Flag.h:38
void stream(std::ostream &os) const
Defines how fields are printed.
Definition: Flag.h:60
static std::string getTypeString()
Return a string description of the field type.
Definition: Flag.h:41
FieldBase(FieldBase &&)=default
FieldBase(FieldBase const &)=default
FieldBase & operator=(FieldBase &&)=default
bool Value
the type returned by BaseRecord::get
Definition: Flag.h:34
Field base class default implementation (used for numeric scalars and lsst::geom::Angle).
Definition: FieldBase.h:41
static std::string getTypeString()
Return a string description of the field type.
Definition: FieldBase.cc:56
Value getValue(Element const *p, ndarray::Manager::Ptr const &) const
Used to implement BaseRecord::get.
Definition: FieldBase.h:81
void setValue(Element *p, ndarray::Manager::Ptr const &, Value v) const
Used to implement BaseRecord::set.
Definition: FieldBase.h:84
T Value
the type returned by BaseRecord::get
Definition: FieldBase.h:42
T Element
the type of subfields (the same as the type itself for scalars)
Definition: FieldBase.h:45
size_t operator()(argument_type const &obj) const noexcept
Definition: Flag.h:193