Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+cbf1bea503,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+db04660fe6,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+3526b51a37,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g919ac25b3e+6220c5324a,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+3d8a3b7e46,ge278dab8ac+932305ba37,gf795337580+03b96afe58,gfba249425e+fcb1d3bbc8,w.2025.08
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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