field.hh

Go to the documentation of this file.

/*
 *  Copyright 2007 Martin von Gagern
 *
 *
 *  This file is part of mqn2mps.
 *
 *  mqn2mps is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  mqn2mps 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef FIELD_HH
#define FIELD_HH

/**
 * @file
 * Interface of class field.
 */

/**
 * A column of the output problem formulation, along with its values.
 *
 * In terms of the matrix of a linear program, a field object
 * describes a single column, giving its name as well as the matrix
 * elements in that column.
 *
 * Columns may come directly from the input field description, but
 * additional columns are created during problem transformation, and
 * most will be expressed through an object of this class as well.
 *
 * The object does not store any information about the bounds of the
 * variable associated with this column.
 */
class field {
public:

  /**
   * The name of the column.
   * If the object belongs to a field from the input description, the
   * field name given there will be stored. For internally generated
   * columns, unique names starting with an underscore will be
   * chosen.
   */
  std::string name;

  /**
   * The matrix elements of the column.
   * The values correspond to quantum numbers according to the order
   * stored in driver::names.
   */
  std::vector<rational> values;

  field();
  field(std::string* name, std::vector<rational>* values);
  void swap(field& other);

};

namespace std {

  /**
   * Specialization of swap operation for field references.
   * This allows efficient swapping in generic algorithms.
   * All members of the class will be swapped individually, which
   * avoids a bit of overhead that would result from assignments in
   * the default implementation.
   *
   * @param a reference of one object to be swapped.
   * @param b reference of the other object to be swapped.
   */
  template<> inline void swap(field& a, field& b) {
    a.swap(b);
  }

}

#endif // ifndef FIELD_HH

---