LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
Key.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2#ifndef AFW_TABLE_Key_h_INCLUDED
3#define AFW_TABLE_Key_h_INCLUDED
4
6
10
11namespace lsst {
12namespace afw {
13namespace table {
14
15namespace detail {
16
17class Access;
18
19} // namespace detail
20
52template <typename T>
53class Key : public KeyBase<T>, public FieldBase<T> {
54public:
56
65 template <typename OtherT>
66 bool operator==(Key<OtherT> const& other) const noexcept {
67 return false;
68 }
69 template <typename OtherT>
70 bool operator!=(Key<OtherT> const& other) const noexcept {
71 return true;
72 }
73
74 bool operator==(Key const& other) const noexcept {
75 return _offset == other._offset && this->getElementCount() == other.getElementCount();
76 }
77 bool operator!=(Key const& other) const noexcept { return !this->operator==(other); }
79
81 std::size_t hash_value() const noexcept {
82 // Completely arbitrary seed
83 return cpputils::hashCombine(17, _offset, this->getElementCount());
84 }
85
87 std::size_t getOffset() const noexcept { return _offset; }
88
97 bool isValid() const noexcept { return _valid; }
98
104 Key() noexcept : FieldBase<T>(FieldBase<T>::makeDefault()), _offset(0), _valid(false) {}
105
106 Key(Key const&) noexcept = default;
107 Key(Key&&) noexcept = default;
108 Key& operator=(Key const&) noexcept = default;
109 Key& operator=(Key&&) noexcept = default;
110 ~Key() noexcept = default;
111
113 inline friend std::ostream& operator<<(std::ostream& os, Key<T> const& key) {
114 return os << "Key<" << Key<T>::getTypeString() << ">(offset=" << key.getOffset()
115 << ", nElements=" << key.getElementCount() << ")";
116 }
117
118private:
119 friend class detail::Access;
120 friend class BaseRecord;
121
122 explicit Key(std::size_t offset, FieldBase<T> const& fb = FieldBase<T>()) noexcept
123 : FieldBase<T>(fb), _offset(offset), _valid(true) {}
124
125 std::size_t _offset;
126 bool _valid;
127};
128} // namespace table
129} // namespace afw
130} // namespace lsst
131
132namespace std {
133template <typename T>
134struct hash<lsst::afw::table::Key<T>> {
137 size_t operator()(argument_type const& obj) const noexcept { return obj.hash_value(); }
138};
139} // namespace std
140
141#endif // !AFW_TABLE_Key_h_INCLUDED
A base class for Key that allows subfield keys to be extracted for some field types.
Definition KeyBase.h:20
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
std::size_t getOffset() const noexcept
Return the offset (in bytes) of this field within a record.
Definition Key.h:87
bool operator!=(Key const &other) const noexcept
Definition Key.h:77
Key() noexcept
Default construct a field.
Definition Key.h:104
Key(Key &&) noexcept=default
bool isValid() const noexcept
Return true if the key was initialized to valid offset.
Definition Key.h:97
std::size_t hash_value() const noexcept
Return a hash of this object.
Definition Key.h:81
bool operator==(Key const &other) const noexcept
Definition Key.h:74
bool operator!=(Key< OtherT > const &other) const noexcept
Definition Key.h:70
Key(Key const &) noexcept=default
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition hashCombine.h:35
STL namespace.
static std::string getTypeString()
Return a string description of the field type.
Definition FieldBase.cc:56
std::size_t getElementCount() const noexcept
Return the number of subfield elements (always one for scalars).
Definition FieldBase.h:48
static FieldBase makeDefault() noexcept
Definition FieldBase.h:69
lsst::afw::table::Key< T > argument_type
Definition Key.h:135
size_t operator()(argument_type const &obj) const noexcept
Definition Key.h:137