layouts.h

Go to the documentation of this file.

/*
 * This file is part of Quantum++.
 *
 * MIT License
 *
 * Copyright (c) 2013 - 2020 Vlad Gheorghiu.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef CLASSES_LAYOUTS_H_
#define CLASSES_LAYOUTS_H_

namespace qpp {

class ILayout {
  public:
    virtual idx operator()(const std::vector<idx>& xs) const = 0;

    virtual std::vector<idx> to_coordinates(idx i) const = 0;

    virtual std::vector<idx> get_dims() const = 0;

    virtual ~ILayout() = default;
}; /* class ILayout */

class Lattice : public ILayout {
  protected:
    std::vector<idx> dims_; 
  public:
    Lattice(const std::vector<idx>& dims) : dims_{dims} {
        // EXCEPTION CHECKS

        if (dims.empty())
            throw exception::ZeroSize("qpp::Lattice::Lattice()");
        // END EXCEPTION CHECKS
    }

    template <class... Ts>
    Lattice(Ts... ds) : Lattice(std::vector<idx>{static_cast<idx>(ds)...}) {}

    idx operator()(const std::vector<idx>& xs) const override {
        // EXCEPTION CHECKS

        if (xs.size() != dims_.size())
            throw exception::DimsNotEqual("qpp::Lattice::operator()");
        for (idx i = 0; i < dims_.size(); ++i)
            if (xs[i] >= dims_[i])
                throw exception::OutOfRange("qpp::Lattice::operator()");
        // END EXCEPTION CHECKS

        return internal::multiidx2n(xs.data(), dims_.size(), dims_.data());
    }

    template <class... Ts>
    idx operator()(Ts... xs) const {
        return operator()(std::vector<idx>{static_cast<idx>(xs)...});
    }

    std::vector<idx> to_coordinates(idx i) const override {
        // EXCEPTION CHECKS

        if (i >= prod(dims_))
            throw exception::OutOfRange("qpp::Lattice::to_coordinates()");
        // END EXCEPTION CHECKS

        std::vector<idx> result(dims_.size());
        internal::n2multiidx(i, dims_.size(), dims_.data(), result.data());

        return result;
    }

    std::vector<idx> get_dims() const override { return dims_; }
}; /* class Lattice */

class PeriodicBoundaryLattice : public Lattice {
  public:
    using Lattice::Lattice;
    using Lattice::operator();

    idx operator()(const std::vector<idx>& xs) const override {
        // EXCEPTION CHECKS

        if (xs.size() != dims_.size())
            throw exception::DimsNotEqual("qpp::Lattice::operator()");
        // END EXCEPTION CHECKS

        std::vector<idx> xs_copy = xs;
        for (idx i = 0; i < dims_.size(); ++i)
            xs_copy[i] = xs[i] % dims_[i];
        return Lattice::operator()(xs_copy);
    }
}; /* class PeriodicBoundaryLattice */

} /* namespace qpp */

#endif /* CLASSES_LAYOUTS_H_ */