ALPS Project: lattice library

Header file: lattice/simplecell.h

defines a template class simple_cell, which makes a descriptor for a cell with finite offset for a unit cell.

Synopsis

namespace alps {

  template <class UnitCell=EmptyUnitCell, class Offset=typename std::vector<int> >
  class simple_cell  {
  public:
    typedef UnitCell unit_cell_type;
    typedef Offset offset_type;
    typedef typename lattice::dimensional_traits<UnitCell>::dimension_type dimension_type;
  
    simple_cell(const unit_cell_type& u, const offset_type& o);
  
    const offset_type& offset() const;
    dimension_type dimension();
  };

}

The simple_cell class

describes a cell and fulfills the Dimensional and Cell requirements.

Template paramaters

It takes two template arguments:
Type definitions
typedef UnitCell unit_cell_type;
typedef Offset offset_type;
typedefs for the template parameters.
typedef typename lattice::dimensional_traits<UnitCell>::dimension_type dimension_type;
the type for the dimension of the cell.

Constructor

simple_cell(const unit_cell_type& u, const offset_typeamp;& o);
the constructor takes the unit cell (to obtain the dimension of the cell), and an offset.

Member functions

const offset_type& offset() const;
returns the offset of the cell.
dimension_type dimension();
returns the dimension of the cell.

copyright (c) 1994-2010 by Matthias Troyer

Distributed under the Boost Software License, Version 1.0. (See http://www.boost.org/LICENSE_1_0.txt)