stopping_status.hpp

// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef GKO_PUBLIC_CORE_STOP_STOPPING_STATUS_HPP_
#define GKO_PUBLIC_CORE_STOP_STOPPING_STATUS_HPP_
 
 
#include <ginkgo/core/base/array.hpp>
#include <ginkgo/core/base/types.hpp>
 
 
namespace gko {
 
 
class stopping_status {
    friend GKO_ATTRIBUTES GKO_INLINE bool operator==(
        const stopping_status& x, const stopping_status& y) noexcept;
    friend GKO_ATTRIBUTES GKO_INLINE bool operator!=(
        const stopping_status& x, const stopping_status& y) noexcept;
 
public:
    GKO_ATTRIBUTES GKO_INLINE bool has_stopped() const noexcept
    {
        return get_id();
    }
 
    GKO_ATTRIBUTES GKO_INLINE bool has_converged() const noexcept
    {
        return data_ & converged_mask_;
    }
 
    GKO_ATTRIBUTES GKO_INLINE bool is_finalized() const noexcept
    {
        return data_ & finalized_mask_;
    }
 
    GKO_ATTRIBUTES GKO_INLINE uint8 get_id() const noexcept
    {
        return data_ & id_mask_;
    }
 
    GKO_ATTRIBUTES GKO_INLINE void reset() noexcept { data_ = uint8{0}; }
 
    GKO_ATTRIBUTES GKO_INLINE void stop(uint8 id,
                                        bool set_finalized = true) noexcept
    {
        if (!this->has_stopped()) {
            data_ |= (id & id_mask_);
            if (set_finalized) {
                data_ |= finalized_mask_;
            }
        }
    }
 
    GKO_ATTRIBUTES GKO_INLINE void converge(uint8 id,
                                            bool set_finalized = true) noexcept
    {
        if (!this->has_stopped()) {
            data_ |= converged_mask_ | (id & id_mask_);
            if (set_finalized) {
                data_ |= finalized_mask_;
            }
        }
    }
 
    GKO_ATTRIBUTES GKO_INLINE void finalize() noexcept
    {
        if (this->has_stopped()) {
            data_ |= finalized_mask_;
        }
    }
 
private:
    static constexpr uint8 converged_mask_ = uint8{1} << 7;
    static constexpr uint8 finalized_mask_ = uint8{1} << 6;
    static constexpr uint8 id_mask_ = (uint8{1} << 6) - uint8{1};
 
    uint8 data_;
};
 
 
GKO_ATTRIBUTES GKO_INLINE bool operator==(const stopping_status& x,
                                          const stopping_status& y) noexcept
{
    return x.data_ == y.data_;
}
 
 
GKO_ATTRIBUTES GKO_INLINE bool operator!=(const stopping_status& x,
                                          const stopping_status& y) noexcept
{
    return x.data_ != y.data_;
}
 
 
}  // namespace gko
 
 
#endif  // GKO_PUBLIC_CORE_STOP_STOPPING_STATUS_HPP_