parameter_name.h

Go to the documentation of this file.

/*
 * Copyright 2024 MusicScience37 (Kenta Kabashima)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once
 
#include <cstddef>
#include <functional>
#include <ostream>
#include <string>
#include <utility>
 
#include <fmt/base.h>
 
#include "stat_bench/util/utf8_string.h"
 
namespace stat_bench {
namespace param {

class ParameterName {
public:
    explicit ParameterName(util::Utf8String str) noexcept;

    explicit ParameterName(std::string str)
        : ParameterName(util::Utf8String(std::move(str))) {}

    [[nodiscard]] auto str() const noexcept -> const util::Utf8String&;
 
private:
    util::Utf8String str_;
};

[[nodiscard]] inline auto operator==(
    const ParameterName& lhs, const ParameterName& rhs) noexcept -> bool {
    return lhs.str() == rhs.str();
}

[[nodiscard]] inline auto operator!=(
    const ParameterName& lhs, const ParameterName& rhs) noexcept -> bool {
    return !(lhs == rhs);
}

[[nodiscard]] inline auto operator<(
    const ParameterName& lhs, const ParameterName& rhs) noexcept -> bool {
    return lhs.str() < rhs.str();
}

[[nodiscard]] inline auto operator>(
    const ParameterName& lhs, const ParameterName& rhs) noexcept -> bool {
    return rhs < lhs;
}

[[nodiscard]] inline auto operator<=(
    const ParameterName& lhs, const ParameterName& rhs) noexcept -> bool {
    return !(rhs < lhs);
}

[[nodiscard]] inline auto operator>=(
    const ParameterName& lhs, const ParameterName& rhs) noexcept -> bool {
    return !(lhs < rhs);
}
 
}  // namespace param
}  // namespace stat_bench
 
namespace fmt {

template <>
struct formatter<stat_bench::param::ParameterName>
    : public formatter<stat_bench::util::Utf8String> {
    auto format(const stat_bench::param::ParameterName& val,
        fmt::format_context& context) const -> fmt::format_context::iterator {
        return formatter<stat_bench::util::Utf8String>::format(
            val.str(), context);
    }
};
 
}  // namespace fmt
 
namespace stat_bench {
namespace param {

inline auto operator<<(std::ostream& stream, const ParameterName& val)
    -> std::ostream& {
    return stream << val.str();
}
 
}  // namespace param
}  // namespace stat_bench
 
namespace std {

template <>
class hash<stat_bench::param::ParameterName> {
public:
    auto operator()(const stat_bench::param::ParameterName& val) const
        -> std::size_t {
        return hash_(val.str());
    }
 
private:
    std::hash<stat_bench::util::Utf8String> hash_;
};
 
}  // namespace std