LinearOperator.cpp

#include "LinearOperator.h"

#include <stdexcept>
#include <typeinfo>

#include "DescriptorUtils.h"

namespace elsa
{
    template <typename data_t>
    LinearOperator<data_t>::LinearOperator(const DataDescriptor& domainDescriptor,
                                           const DataDescriptor& rangeDescriptor)
        : _domainDescriptor{domainDescriptor.clone()}, _rangeDescriptor{rangeDescriptor.clone()}
    {
    }

    template <typename data_t>
    LinearOperator<data_t>::LinearOperator(const LinearOperator<data_t>& other)
        : Cloneable<LinearOperator<data_t>>(),
          _domainDescriptor{other._domainDescriptor->clone()},
          _rangeDescriptor{other._rangeDescriptor->clone()},
          _isLeaf{other._isLeaf},
          _isAdjoint{other._isAdjoint},
          _isComposite{other._isComposite},
          _mode{other._mode}
    {
        if (_isLeaf)
            _lhs = other._lhs->clone();

        if (_isComposite) {
            _lhs = other._lhs->clone();
            _rhs = other._rhs->clone();
        }
    }

    template <typename data_t>
    LinearOperator<data_t>& LinearOperator<data_t>::operator=(const LinearOperator<data_t>& other)
    {
        if (*this != other) {
            _domainDescriptor = other._domainDescriptor->clone();
            _rangeDescriptor = other._rangeDescriptor->clone();
            _isLeaf = other._isLeaf;
            _isAdjoint = other._isAdjoint;
            _isComposite = other._isComposite;
            _mode = other._mode;

            if (_isLeaf)
                _lhs = other._lhs->clone();

            if (_isComposite) {
                _lhs = other._lhs->clone();
                _rhs = other._rhs->clone();
            }
        }

        return *this;
    }

    template <typename data_t>
    const DataDescriptor& LinearOperator<data_t>::getDomainDescriptor() const
    {
        return *_domainDescriptor;
    }

    template <typename data_t>
    const DataDescriptor& LinearOperator<data_t>::getRangeDescriptor() const
    {
        return *_rangeDescriptor;
    }

    template <typename data_t>
    DataContainer<data_t> LinearOperator<data_t>::apply(const DataContainer<data_t>& x) const
    {
        DataContainer<data_t> result(*_rangeDescriptor, x.getDataHandlerType());
        apply(x, result);
        return result;
    }

    template <typename data_t>
    void LinearOperator<data_t>::apply(const DataContainer<data_t>& x,
                                       DataContainer<data_t>& Ax) const
    {
        applyImpl(x, Ax);
    }

    template <typename data_t>
    void LinearOperator<data_t>::applyImpl(const DataContainer<data_t>& x,
                                           DataContainer<data_t>& Ax) const
    {
        if (_isLeaf) {
            if (_isAdjoint) {
                // sanity check the arguments for the intended evaluation tree leaf operation
                if (_lhs->getRangeDescriptor().getNumberOfCoefficients() != x.getSize()
                    || _lhs->getDomainDescriptor().getNumberOfCoefficients() != Ax.getSize())
                    throw InvalidArgumentError(
                        "LinearOperator::apply: incorrect input/output sizes for adjoint leaf");

                _lhs->applyAdjoint(x, Ax);
                return;
            } else {
                // sanity check the arguments for the intended evaluation tree leaf operation
                if (_lhs->getDomainDescriptor().getNumberOfCoefficients() != x.getSize()
                    || _lhs->getRangeDescriptor().getNumberOfCoefficients() != Ax.getSize())
                    throw InvalidArgumentError(
                        "LinearOperator::apply: incorrect input/output sizes for leaf");

                _lhs->apply(x, Ax);
                return;
            }
        }

        if (_isComposite) {
            if (_mode == CompositeMode::ADD) {
                // sanity check the arguments for the intended evaluation tree leaf operation
                if (_rhs->getDomainDescriptor().getNumberOfCoefficients() != x.getSize()
                    || _rhs->getRangeDescriptor().getNumberOfCoefficients() != Ax.getSize()
                    || _lhs->getDomainDescriptor().getNumberOfCoefficients() != x.getSize()
                    || _lhs->getRangeDescriptor().getNumberOfCoefficients() != Ax.getSize())
                    throw InvalidArgumentError(
                        "LinearOperator::apply: incorrect input/output sizes for add leaf");

                _rhs->apply(x, Ax);
                Ax += _lhs->apply(x);
                return;
            }

            if (_mode == CompositeMode::MULT) {
                // sanity check the arguments for the intended evaluation tree leaf operation
                if (_rhs->getDomainDescriptor().getNumberOfCoefficients() != x.getSize()
                    || _lhs->getRangeDescriptor().getNumberOfCoefficients() != Ax.getSize())
                    throw InvalidArgumentError(
                        "LinearOperator::apply: incorrect input/output sizes for mult leaf");

                DataContainer<data_t> temp(_rhs->getRangeDescriptor(), x.getDataHandlerType());
                _rhs->apply(x, temp);
                _lhs->apply(temp, Ax);
                return;
            }
        }

        throw LogicError("LinearOperator: apply called on ill-formed object");
    }

    template <typename data_t>
    DataContainer<data_t> LinearOperator<data_t>::applyAdjoint(const DataContainer<data_t>& y) const
    {
        DataContainer<data_t> result(*_domainDescriptor, y.getDataHandlerType());
        applyAdjoint(y, result);
        return result;
    }

    template <typename data_t>
    void LinearOperator<data_t>::applyAdjoint(const DataContainer<data_t>& y,
                                              DataContainer<data_t>& Aty) const
    {
        applyAdjointImpl(y, Aty);
    }

    template <typename data_t>
    void LinearOperator<data_t>::applyAdjointImpl(const DataContainer<data_t>& y,
                                                  DataContainer<data_t>& Aty) const
    {
        if (_isLeaf) {
            if (_isAdjoint) {
                // sanity check the arguments for the intended evaluation tree leaf operation
                if (_lhs->getDomainDescriptor().getNumberOfCoefficients() != y.getSize()
                    || _lhs->getRangeDescriptor().getNumberOfCoefficients() != Aty.getSize())
                    throw InvalidArgumentError("LinearOperator::applyAdjoint: incorrect "
                                               "input/output sizes for adjoint leaf");

                _lhs->apply(y, Aty);
                return;
            } else {
                // sanity check the arguments for the intended evaluation tree leaf operation
                if (_lhs->getRangeDescriptor().getNumberOfCoefficients() != y.getSize()
                    || _lhs->getDomainDescriptor().getNumberOfCoefficients() != Aty.getSize())
                    throw InvalidArgumentError(
                        "LinearOperator::applyAdjoint: incorrect input/output sizes for leaf");

                _lhs->applyAdjoint(y, Aty);
                return;
            }
        }

        if (_isComposite) {
            if (_mode == CompositeMode::ADD) {
                // sanity check the arguments for the intended evaluation tree leaf operation
                if (_rhs->getRangeDescriptor().getNumberOfCoefficients() != y.getSize()
                    || _rhs->getDomainDescriptor().getNumberOfCoefficients() != Aty.getSize()
                    || _lhs->getRangeDescriptor().getNumberOfCoefficients() != y.getSize()
                    || _lhs->getDomainDescriptor().getNumberOfCoefficients() != Aty.getSize())
                    throw InvalidArgumentError(
                        "LinearOperator::applyAdjoint: incorrect input/output sizes for add leaf");

                _rhs->applyAdjoint(y, Aty);
                Aty += _lhs->applyAdjoint(y);
                return;
            }

            if (_mode == CompositeMode::MULT) {
                // sanity check the arguments for the intended evaluation tree leaf operation
                if (_lhs->getRangeDescriptor().getNumberOfCoefficients() != y.getSize()
                    || _rhs->getDomainDescriptor().getNumberOfCoefficients() != Aty.getSize())
                    throw InvalidArgumentError(
                        "LinearOperator::applyAdjoint: incorrect input/output sizes for mult leaf");

                DataContainer<data_t> temp(_lhs->getDomainDescriptor(), y.getDataHandlerType());
                _lhs->applyAdjoint(y, temp);
                _rhs->applyAdjoint(temp, Aty);
                return;
            }
        }

        throw LogicError("LinearOperator: applyAdjoint called on ill-formed object");
    }

    template <typename data_t>
    LinearOperator<data_t>* LinearOperator<data_t>::cloneImpl() const
    {
        if (_isLeaf)
            return new LinearOperator<data_t>(*_lhs, _isAdjoint);

        if (_isComposite)
            return new LinearOperator<data_t>(*_lhs, *_rhs, _mode);

        return new LinearOperator<data_t>(*_domainDescriptor, *_rangeDescriptor);
    }

    template <typename data_t>
    bool LinearOperator<data_t>::isEqual(const LinearOperator<data_t>& other) const
    {
        if (typeid(other) != typeid(*this))
            return false;

        if (*_domainDescriptor != *other._domainDescriptor
            || *_rangeDescriptor != *other._rangeDescriptor)
            return false;

        if (_isLeaf ^ other._isLeaf || _isComposite ^ other._isComposite)
            return false;

        if (_isLeaf)
            return (_isAdjoint == other._isAdjoint) && (*_lhs == *other._lhs);

        if (_isComposite)
            return _mode == other._mode && (*_lhs == *other._lhs) && (*_rhs == *other._rhs);

        return true;
    }

    template <typename data_t>
    LinearOperator<data_t>::LinearOperator(const LinearOperator<data_t>& op, bool isAdjoint)
        : _domainDescriptor{(isAdjoint) ? op.getRangeDescriptor().clone()
                                        : op.getDomainDescriptor().clone()},
          _rangeDescriptor{(isAdjoint) ? op.getDomainDescriptor().clone()
                                       : op.getRangeDescriptor().clone()},
          _lhs{op.clone()},
          _isLeaf{true},
          _isAdjoint{isAdjoint}
    {
    }

    template <typename data_t>
    LinearOperator<data_t>::LinearOperator(const LinearOperator<data_t>& lhs,
                                           const LinearOperator<data_t>& rhs, CompositeMode mode)
        : _domainDescriptor{mode == CompositeMode::MULT
                                ? rhs.getDomainDescriptor().clone()
                                : bestCommon(*lhs._domainDescriptor, *rhs._domainDescriptor)},
          _rangeDescriptor{mode == CompositeMode::MULT
                               ? lhs.getRangeDescriptor().clone()
                               : bestCommon(*lhs._rangeDescriptor, *rhs._rangeDescriptor)},
          _lhs{lhs.clone()},
          _rhs{rhs.clone()},
          _isComposite{true},
          _mode{mode}
    {
        // sanity check the descriptors
        switch (_mode) {
            case CompositeMode::ADD:
                /// feasibility checked by bestCommon()
                break;

            case CompositeMode::MULT:
                // for multiplication, domain of _lhs should match range of _rhs
                if (_lhs->getDomainDescriptor().getNumberOfCoefficients()
                    != _rhs->getRangeDescriptor().getNumberOfCoefficients())
                    throw InvalidArgumentError(
                        "LinearOperator: composite mult domain/range mismatch");
                break;

            default:
                throw LogicError("LinearOperator: unknown composition mode");
        }
    }

    // ------------------------------------------
    // explicit template instantiation
    template class LinearOperator<float>;
    template class LinearOperator<std::complex<float>>;
    template class LinearOperator<double>;
    template class LinearOperator<std::complex<double>>;

} // namespace elsa