MatrixSquareBracketsAccess.h

Go to the documentation of this file.

/* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   Copyright (c) 2013 The plumed team
   (see the PEOPLE file at the root of the distribution for a list of names)

   See http://www.plumed-code.org for more information.

   This file is part of plumed, version 2.0.

   plumed 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 3 of the License, or
   (at your option) any later version.

   plumed 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 plumed.  If not, see <http://www.gnu.org/licenses/>.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ */
#ifndef __PLUMED_tools_MatrixSquareBracketsAccess_h
#define __PLUMED_tools_MatrixSquareBracketsAccess_h

namespace PLMD{

/**
Utility class to add [][] access

\tparam T The type of the matrix class.
\tparam C The type of the returned value.
\tparam I The type of the first index (default unsigned).
\tparam J The type of the second index (default unsigned).

It implements the trick described in C++ FAQ 13.12 to allow [][] access
to matrix-like classes, based on the (,) syntax, thus translating
[i][j] into (i,j).  In practice, one only needs to implement the (,) syntax and to inherit from
MatrixSquareBracketsAccess.
The first template parameter (T) should be the
class itself, the second (C) is the type of the returned value,
and the third (I) and fourth (J) are the types of the two indexes (unsigned by default).
As everything is inlined, no overhead is expected.

\verbatim

class MyMatrixClass:
  public MatrixSquareBracketsAccess<MyMatrixClass,double>
{
  double data[16];
public:
  double & operator ()(unsigned i,unsigned j){
    return data[4*i+j];
  }
  const double & operator ()(unsigned i,unsigned j)const{
    return data[4*i+j];
  }
};

int main(){
  MyMatrixClass m;
  m[0][1]=3.0;
  return 0;
}
\endverbatim

*/

template<class T,class C,class I=unsigned,class J=unsigned>
class MatrixSquareBracketsAccess{
/// Small utility class which just contains a pointer to the T and the row number
  class Const_row{
    friend class MatrixSquareBracketsAccess; // this so as to allow only T to instantiate Const_row
                    // the user should not manipulate it directly
    const MatrixSquareBracketsAccess& t;
    const I i;
    Const_row(const MatrixSquareBracketsAccess&t,I i); // constructor is private and cannot be manipulated by the user
  public:
  /// access element
    const C & operator[] (J j)const;
  };
/// Small utility class which just contains a pointer to the T and the row number
  class Row{
    friend class MatrixSquareBracketsAccess; // this so as to allow only T to instantiate Const_row
                         // the user should not manipulate it directly
    MatrixSquareBracketsAccess& t;
    const I i;
    Row(MatrixSquareBracketsAccess&t,I i); // constructor is private and cannot be manipulated by the user
  public:
  /// access element
    C & operator[] (J j);
  };
public:
/// access element (with [][] syntax)
  Row operator[] (I i);
/// access element (with [][] syntax)
  Const_row operator[] (I i)const;
};

template<class T,class C,class I,class J>
MatrixSquareBracketsAccess<T,C,I,J>::Const_row::Const_row(const MatrixSquareBracketsAccess&t,I i):
  t(t),i(i){}

template<class T,class C,class I,class J>
MatrixSquareBracketsAccess<T,C,I,J>::Row::Row(MatrixSquareBracketsAccess&t,I i):
  t(t),i(i){}

template<class T,class C,class I,class J>
const C & MatrixSquareBracketsAccess<T,C,I,J>::Const_row::operator[] (J j)const{
  return (*static_cast<const T*>(&t))(i,j);
}

template<class T,class C,class I,class J>
C & MatrixSquareBracketsAccess<T,C,I,J>::Row::operator[] (J j){
  return (*static_cast<T*>(&t))(i,j);
}

template<class T,class C,class I,class J>
typename MatrixSquareBracketsAccess<T,C,I,J>::Row MatrixSquareBracketsAccess<T,C,I,J>::operator[] (I i){
  return Row(*this,i);
}

template<class T,class C,class I,class J>
typename MatrixSquareBracketsAccess<T,C,I,J>::Const_row MatrixSquareBracketsAccess<T,C,I,J>::operator[] (I i)const{
  return Const_row(*this,i);
}

}


#endif