Program Listing for File ilparams.h

↰ Return to documentation for file (core/include/lattice/hal/default/ilparams.h)

//==================================================================================
// BSD 2-Clause License
//
// Copyright (c) 2014-2023, NJIT, Duality Technologies Inc. and other contributors
//
// All rights reserved.
//
// Author TPOC: contact@openfhe.org
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//==================================================================================

/*
  Wraps parameters for integer lattice operations. Inherits from ElemParams
 */

#ifndef LBCRYPTO_INC_LATTICE_ILPARAMS_H
#define LBCRYPTO_INC_LATTICE_ILPARAMS_H

#include "lattice/hal/elemparams.h"

#include "math/hal/basicint.h"
#include "math/math-hal.h"
#include "math/nbtheory.h"

#include "utils/exception.h"
#include "utils/inttypes.h"

#include <string>
#include <utility>

namespace lbcrypto {

template <typename IntType>
class ILParamsImpl final : public ElemParams<IntType> {
public:
    using Integer = IntType;

    constexpr ILParamsImpl() : ElemParams<IntType>() {}
    ~ILParamsImpl() override = default;

    explicit ILParamsImpl(uint32_t order, uint32_t bits = MAX_MODULUS_SIZE)
        : ILParamsImpl<IntType>(order, LastPrime<IntType>(bits, order)) {}

    explicit ILParamsImpl(uint32_t order, const IntType& modulus)
        : ElemParams<IntType>(order, modulus, RootOfUnity<IntType>(order, modulus)) {}

    ILParamsImpl(uint32_t order, const IntType& modulus, const IntType& rootOfUnity)
        : ElemParams<IntType>(order, modulus, rootOfUnity) {}

    ILParamsImpl(uint32_t order, const IntType& modulus, const IntType& rootOfUnity, const IntType& bigModulus,
                 const IntType& bigRootOfUnity)
        : ElemParams<IntType>(order, modulus, rootOfUnity, bigModulus, bigRootOfUnity) {}

    ILParamsImpl(const ILParamsImpl& rhs) : ElemParams<IntType>(rhs) {}

    ILParamsImpl& operator=(const ILParamsImpl& rhs) {
        ElemParams<IntType>::operator=(rhs);
        return *this;
    }

    ILParamsImpl(ILParamsImpl&& rhs) noexcept : ElemParams<IntType>(std::move(rhs)) {}

    ILParamsImpl& operator=(ILParamsImpl&& rhs) noexcept {
        ElemParams<IntType>::operator=(std::move(rhs));
        return *this;
    }

    bool operator==(const ElemParams<IntType>& rhs) const override {
        if (!dynamic_cast<const ILParamsImpl<IntType>*>(&rhs))
            return false;
        return ElemParams<IntType>::operator==(rhs);
    }

    template <class Archive>
    void save(Archive& ar, std::uint32_t const version) const {
        ar(::cereal::base_class<ElemParams<IntType>>(this));
    }

    template <class Archive>
    void load(Archive& ar, std::uint32_t const version) {
        if (version > SerializedVersion())
            OPENFHE_THROW("serialized object version " + std::to_string(version) +
                          " is from a later version of the library");
        ar(::cereal::base_class<ElemParams<IntType>>(this));
    }

    std::string SerializedObjectName() const override {
        return "ILParms";
    }

    static uint32_t SerializedVersion() {
        return 1;
    }

private:
    std::ostream& doprint(std::ostream& out) const override {
        out << "ILParams ";
        ElemParams<IntType>::doprint(out);
        return out << std::endl;
    }
};

}  // namespace lbcrypto

#endif