SubMat.h

/*
 * Expression Template Matrix Library
 *
 * Copyright (C) 2004 - 2006 Ricky Lung <mtlung@users.sourceforge.net>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */


// Forward declaration
template<class Rep, class ExtraTParam> class StaticConstSubMatView;
template<class Rep> class DynConstSubMatView;

template<class Rep, class ExtraTParam>
class StaticSubMatView : public StaticSubMatViewTag
{
public:
    typedef StaticSubMatView<Rep, ExtraTParam>      self_type;
    typedef StaticSubMatViewTag                     exp_tag;
    typedef ExtraTParam                             extra_param_type;
    typedef StaticConstSubMatView<Rep, ExtraTParam> const_view_type;
    COMMON_VIEW_TYPEDEFS();

    enum {
        TOP = ExtraTParam::INT1,    // Top of the sub-matrix
        LEFT = ExtraTParam::INT2,   // Left of the sub-matrix
        RS = ExtraTParam::INT3,     // No. of rows of the sub-matrix
        CS = ExtraTParam::INT4,     // No. of columns of the sub-matrix
        ROWS = RS,
        COLS = CS,
        IsLinear = true,
        IsLinearRecursive = IsLinear && super_type::IsLinearRecursive,
        TNOP = 0,
        ENOP = 0,
        EXPLevel = Rep::EXPLevel + 1
    };

    typedef Mat<DenseMatCon<value_type,ROWS,COLS>, EmptyErrorChecker> temp_type;

    /************************************************/
    // Constructors
    EXMAT_INLINE2 StaticSubMatView(const self_type& self)
        : rep(self.rep) {}
    EXMAT_INLINE2 StaticSubMatView(Rep& mat)
        : rep(mat) { ComErrCheck(); }
    template<class Rep2> EXMAT_INLINE2
    StaticSubMatView(const Rep2& self, Rep& mat)
        : rep(mat) {
        THROWMSG(ROWS==Rep2::ROWS && COLS==Rep2::COLS, InternalErrMsg, __FILE__);
        ComErrCheck();
    }

    /************************************************/
    // Dimension information
    EXMAT_INLINE2 size_t size() const { return ROWS*COLS; }
    EXMAT_INLINE2 size_t rows() const { return ROWS; }
    EXMAT_INLINE2 size_t cols() const { return COLS; }
    /************************************************/
    // Index function (for internal use, no error checking applied)
    EXMAT_INLINE2 reference setAt(index_type i)
    {   return this->setAt(i/COLS, i%COLS); }
    EXMAT_INLINE2 const_reference getAt(index_type i) const
    {   return this->getAt(i/COLS, i%COLS); }
    EXMAT_INLINE2 reference setAt(index_type i, index_type j)
    {   return rep.setAt(i+TOP, j+LEFT);    }
    EXMAT_INLINE2 const_reference getAt(index_type i, index_type j) const
    {   return rep.getAt(i+TOP, j+LEFT);    }

private:
    // Compatibility error checking
    EXMAT_INLINE2 void ComErrCheck() {
        #if EXMAT_STATIC_CHECK
            StaticAssert1(TOP >= 0, RowOutOfRange);
            StaticAssert1(LEFT >= 0, ColOutOfRange);
            StaticAssert1(TOP+RS <= super_type::ROWS, RowOutOfRange);
            StaticAssert1(LEFT+CS <= super_type::COLS, ColOutOfRange);
        #else
            DefaultErrorChecker::AssertCompat(
                TOP >= 0 && LEFT >= 0 &&
                (TOP+RS <= super_type::ROWS) && (LEFT+CS <= super_type::COLS)
            );
        #endif  // EXMAT_STATIC_CHECK
    }
};
#if !EXMAT_VC6

template<class Rep, class ErrChk, int TOP, int LEFT, int RS, int CS> EXMAT_INLINE2 static
Mat<ExpMat<StaticSubMatView<Rep,TParamINT4<TOP,LEFT,RS,CS> > >, ErrChk>
subMat(Mat<Rep, ErrChk>& mat, Int2Type<TOP>, Int2Type<LEFT>, Int2Type<RS>, Int2Type<CS>) {
    return Mat<ExpMat<StaticSubMatView<Rep,TParamINT4<TOP,LEFT,RS,CS> > >, ErrChk>(
        ExpMat<StaticSubMatView<Rep,TParamINT4<TOP,LEFT,RS,CS> > >(mat)
    );
}
#endif  // !EXMAT_VC6


template<class Rep, class ExtraTParam>
class StaticConstSubMatView : public StaticSubMatViewTag
{
public:
    typedef StaticConstSubMatView<Rep, ExtraTParam> self_type;
    typedef StaticSubMatViewTag                     exp_tag;
    typedef ExtraTParam                             extra_param_type;
    COMMON_CONST_VIEW_TYPEDEFS();

    enum {
        TOP = ExtraTParam::INT1,    // Top of the sub-matrix
        LEFT = ExtraTParam::INT2,   // Left of the sub-matrix
        RS = ExtraTParam::INT3,     // No. of rows of the sub-matrix
        CS = ExtraTParam::INT4,     // No. of columns of the sub-matrix
        ROWS = RS,
        COLS = CS,
        IsLinear = true,
        IsLinearRecursive = IsLinear && super_type::IsLinearRecursive,
        TNOP = 0,
        ENOP = 0,
        EXPLevel = Rep::EXPLevel + 1
    };

    typedef Mat<DenseMatCon<value_type,ROWS,COLS>, EmptyErrorChecker> temp_type;

    /************************************************/
    // Constructors
    EXMAT_INLINE2 StaticConstSubMatView(const self_type& self)
        : rep(self.rep) {}
    EXMAT_INLINE2 StaticConstSubMatView(const Rep& mat)
        : rep(mat) { ComErrCheck(); }
    template<class Rep2> EXMAT_INLINE2
    StaticConstSubMatView(const Rep2& self, const Rep& mat)
        : rep(mat) {
        THROWMSG(ROWS==Rep2::ROWS && COLS==Rep2::COLS, InternalErrMsg, __FILE__);
        ComErrCheck();
    }

    /************************************************/
    // Dimension information
    EXMAT_INLINE2 size_t size() const { return ROWS*COLS; }
    EXMAT_INLINE2 size_t rows() const { return ROWS; }
    EXMAT_INLINE2 size_t cols() const { return COLS; }
    /************************************************/
    // Index function (for internal use, no error checking applied)
    EXMAT_INLINE2 const_reference getAt(index_type i) const
    {   return this->getAt(i/COLS, i%COLS); }
    EXMAT_INLINE2 const_reference getAt(index_type i, index_type j) const
    {   return rep.getAt(i+TOP, j+LEFT);    }

private:
    // Compatibility error checking
    EXMAT_INLINE2 void ComErrCheck() {
        #if EXMAT_STATIC_CHECK
            StaticAssert1(TOP >= 0, RowOutOfRange);
            StaticAssert1(LEFT >= 0, ColOutOfRange);
            StaticAssert1(TOP+RS <= super_type::ROWS, RowOutOfRange);
            StaticAssert1(LEFT+CS <= super_type::COLS, ColOutOfRange);
        #else
            DefaultErrorChecker::AssertCompat(
                TOP >= 0 && LEFT >= 0 &&
                (TOP+RS <= super_type::ROWS) && (LEFT+CS <= super_type::COLS)
            );
        #endif  // EXMAT_STATIC_CHECK
    }
};
#if !EXMAT_VC6

template<class Rep, class ErrChk, int TOP, int LEFT, int RS, int CS> EXMAT_INLINE2 static
const Mat<ExpMat<StaticConstSubMatView<Rep,TParamINT4<TOP,LEFT,RS,CS> > >, ErrChk>
subMat(const Mat<Rep, ErrChk>& mat, Int2Type<TOP>, Int2Type<LEFT>, Int2Type<RS>, Int2Type<CS>) {
    return Mat<ExpMat<StaticConstSubMatView<Rep,TParamINT4<TOP,LEFT,RS,CS> > >, ErrChk>(
        ExpMat<StaticConstSubMatView<Rep,TParamINT4<TOP,LEFT,RS,CS> > >(mat)
    );
}
#endif  // !EXMAT_VC6


template<class Rep>
class DynSubMatView : public DynSubMatViewTag
{
public:
    typedef DynSubMatView<Rep>      self_type;
    typedef DynSubMatViewTag        exp_tag;
    typedef NullTag                 extra_param_type;
    typedef DynConstSubMatView<Rep> const_view_type;
    COMMON_VIEW_TYPEDEFS();

    enum {
        ROWS = 0,
        COLS = 0,
        IsLinear = true,
        IsLinearRecursive = IsLinear && super_type::IsLinearRecursive,
        TNOP = 0,
        ENOP = 0,
        EXPLevel = Rep::EXPLevel + 1
    };

    typedef Mat<DenseMatCon<value_type,ROWS,COLS>, EmptyErrorChecker> temp_type;

    /************************************************/
    // Constructors
    EXMAT_INLINE2 DynSubMatView(const self_type& self)
        : rep(self.rep), top(self.top), left(self.left), rs(self.rs), cs(self.cs) {}
    EXMAT_INLINE2 DynSubMatView(Rep& mat, size_t t, size_t l, size_t r, size_t c)
        : rep(mat), top(t), left(l), rs(r), cs(c) { ComErrCheck(); }
    template<class Rep2> EXMAT_INLINE2
    DynSubMatView(const Rep2& self, Rep& mat)
        : rep(mat), top(self.top), left(self.left), rs(self.rs), cs(self.cs) { ComErrCheck(); }

    /************************************************/
    // Dimension information
    EXMAT_INLINE2 size_t size() const { return rs*cs; }
    EXMAT_INLINE2 size_t rows() const { return rs; }
    EXMAT_INLINE2 size_t cols() const { return cs; }
    /************************************************/
    // Index function (for internal use, no error checking applied)
    EXMAT_INLINE2 reference setAt(index_type i)
    {   return this->setAt(i/cols(), i%cols()); }
    EXMAT_INLINE2 const_reference getAt(index_type i) const
    {   return this->getAt(i/cols(), i%cols()); }
    EXMAT_INLINE2 reference setAt(index_type i, index_type j)
    {   return rep.setAt(i+top, j+left);    }
    EXMAT_INLINE2 const_reference getAt(index_type i, index_type j) const
    {   return rep.getAt(i+top, j+left);    }

public:
    const size_t top, left, rs, cs;

private:
    // Compatibility error checking
    EXMAT_INLINE2 void ComErrCheck() {
        DefaultErrorChecker::AssertCompat(
            (top+rs <= ((super_type*)(this))->rows()) &&
            (left+cs <= ((super_type*)(this))->cols())
        );
    }
};
template<class Rep, class ErrChk> EXMAT_INLINE2 static
Mat<ExpMat<DynSubMatView<Rep> >, ErrChk>
subMat(Mat<Rep, ErrChk>& mat, size_t top, size_t left, size_t rs, size_t cs) {
    return Mat<ExpMat<DynSubMatView<Rep> >, ErrChk>(ExpMat<DynSubMatView<Rep> >(mat, top, left, rs, cs));
}


template<class Rep>
class DynConstSubMatView : public DynSubMatViewTag
{
public:
    typedef DynConstSubMatView<Rep> self_type;
    typedef DynSubMatViewTag        exp_tag;
    typedef NullTag                 extra_param_type;
    COMMON_CONST_VIEW_TYPEDEFS();

    enum {
        ROWS = 0,
        COLS = 0,
        IsLinear = true,
        IsLinearRecursive = IsLinear && super_type::IsLinearRecursive,
        TNOP = 0,
        ENOP = 0,
        EXPLevel = Rep::EXPLevel + 1
    };

    typedef Mat<DenseMatCon<value_type,ROWS,COLS>, EmptyErrorChecker> temp_type;

    /************************************************/
    // Constructors
    EXMAT_INLINE2 DynConstSubMatView(const self_type& self)
        : rep(self.rep), top(self.top), left(self.left), rs(self.rs), cs(self.cs) {}
    EXMAT_INLINE2 DynConstSubMatView(const Rep& mat, size_t t, size_t l, size_t r, size_t c)
        : rep(mat), top(t), left(l), rs(r), cs(c) { ComErrCheck(); }
    template<class Rep2> EXMAT_INLINE2
    DynConstSubMatView(const Rep2& self, const Rep& mat)
        : rep(mat), top(self.top), left(self.left), rs(self.rs), cs(self.cs) { ComErrCheck(); }

    /************************************************/
    // Dimension information
    EXMAT_INLINE2 size_t size() const { return rs*cs; }
    EXMAT_INLINE2 size_t rows() const { return rs; }
    EXMAT_INLINE2 size_t cols() const { return cs; }
    /************************************************/
    // Index function (for internal use, no error checking applied)
    EXMAT_INLINE2 const_reference getAt(index_type i) const
    {   return this->getAt(i/cols(), i%cols()); }
    EXMAT_INLINE2 const_reference getAt(index_type i, index_type j) const
    {   return rep.getAt(i+top, j+left);    }

public:
    const size_t top, left, rs, cs;

private:
    // Compatibility error checking
    EXMAT_INLINE2 void ComErrCheck() {
        DefaultErrorChecker::AssertCompat(
            (top+rs <= ((super_type*)(this))->rows()) &&
            (left+cs <= ((super_type*)(this))->cols())
        );
    }
};
template<class Rep, class ErrChk> EXMAT_INLINE2 static
const Mat<ExpMat<DynConstSubMatView<Rep> >, ErrChk>
subMat(const Mat<Rep, ErrChk>& mat, size_t top, size_t left, size_t rs, size_t cs) {
    return Mat<ExpMat<DynConstSubMatView<Rep> >, ErrChk>(ExpMat<DynConstSubMatView<Rep> >(mat, top, left, rs, cs));
}

---