Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of Boost. Click here to view this page for the latest version.

Class template metadata_base

boost::histogram::axis::metadata_base — Meta data holder with space optimization for empty meta data types.

Synopsis

// In header: <boost/histogram/axis/metadata_base.hpp>

template<typename Metadata, 
         typename DetailMetadata = detail::replace_default<Metadata, std::string> > 
class metadata_base : private empty_value< DetailMetadata > {
public:
  // construct/copy/destruct
  metadata_base() = default;
  metadata_base(const metadata_base &) = default;
  metadata_base(metadata_base &&) noexcept;
  metadata_base(metadata_type &&) noexcept;
  metadata_base & operator=(const metadata_base &) = default;
  metadata_base & operator=(metadata_base &&) noexcept;

  // public member functions
  metadata_type & metadata() noexcept;
  const metadata_type & metadata() const noexcept;
  bool operator==(const metadata_base &) const noexcept;
  bool operator!=(const metadata_base &) const noexcept;
};

Description

`metadata_base` public construct/copy/destruct

```
metadata_base() = default;
```

metadata_base(const metadata_base &) = default;

metadata_base(metadata_base && o) noexcept;

metadata_base(metadata_type && o) noexcept;

metadata_base & operator=(const metadata_base &) = default;

metadata_base & operator=(metadata_base && o) noexcept;

`metadata_base` public member functions

```
metadata_type & metadata() noexcept;
```
Returns reference to metadata.

const metadata_type & metadata() const noexcept;

Returns reference to const metadata.

bool operator==(const metadata_base & o) const noexcept;

bool operator!=(const metadata_base & o) const noexcept;