RhodeCode

/* -*- C++ -*-

 *

 * This file is a part of LEMON, a generic C++ optimization library

 *

 * Copyright (C) 2003-2008

 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport

 * (Egervary Research Group on Combinatorial Optimization, EGRES).

 *

 * Permission to use, modify and distribute this software is granted

 * provided that this copyright notice appears in all copies. For

 * precise terms see the accompanying LICENSE file.

 *

 * This software is provided "AS IS" with no warranty of any kind,

 * express or implied, and with no claim as to its suitability for any

 * purpose.

 *

 */

#ifndef LEMON_CONCEPT_MAPS_H

#define LEMON_CONCEPT_MAPS_H

#include <lemon/bits/utility.h>

#include <lemon/concept_check.h>

///\ingroup concept

///\file

///\brief Map concepts checking classes for testing and documenting.

namespace lemon {

  namespace concepts {

    /// \addtogroup concept

    /// @{

    /// Readable map concept

    /// Readable map concept.

    ///

    template<typename K, typename T>

    class ReadMap

    {

    public:

      /// The key type of the map.

      typedef K Key;

      /// The value type of the map. (The type of objects associated with the keys).

      typedef T Value;

      /// Returns the value associated with the given key.

      template<typename _ReadMap>

      struct Constraints {

	void constraints() {

	  Value val = m[key];

	  val = m[key];

	  typename _ReadMap::Value own_val = m[own_key];

	  own_val = m[own_key];

	  ignore_unused_variable_warning(key);

	  ignore_unused_variable_warning(val);

	  ignore_unused_variable_warning(own_key);

	  ignore_unused_variable_warning(own_val);

	}

	const Key& key;

	const typename _ReadMap::Key& own_key;

	const _ReadMap& m;

      };

    };

    /// Writable map concept

    /// Writable map concept.

    ///

    template<typename K, typename T>

    class WriteMap

    {

    public:

      /// The key type of the map.

      typedef K Key;

      /// The value type of the map. (The type of objects associated with the keys).

      typedef T Value;

      /// Sets the value associated with the given key.

      void set(const Key &, const Value &) {}

      /// Default constructor.

      WriteMap() {}

      template <typename _WriteMap>

      struct Constraints {

	void constraints() {

	  m.set(key, val);

	  m.set(own_key, own_val);

	  ignore_unused_variable_warning(key);

	  ignore_unused_variable_warning(val);

	  ignore_unused_variable_warning(own_key);

	  ignore_unused_variable_warning(own_val);

	}

	const Key& key;

	const Value& val;

	const typename _WriteMap::Key& own_key;

	const typename _WriteMap::Value own_val;

	_WriteMap& m;

      };

    };

    /// Read/writable map concept

    /// Read/writable map concept.

    ///

    template<typename K, typename T>

    class ReadWriteMap : public ReadMap<K,T>,

			 public WriteMap<K,T>

    {

    public:

      /// The key type of the map.

      typedef K Key;

      /// The value type of the map. (The type of objects associated with the keys).

      typedef T Value;

      /// Returns the value associated with the given key.

      /// Sets the value associated with the given key.

      void set(const Key &, const Value &) {}

      template<typename _ReadWriteMap>

      struct Constraints {

	void constraints() {

	  checkConcept<ReadMap<K, T>, _ReadWriteMap >();

	  checkConcept<WriteMap<K, T>, _ReadWriteMap >();

	}

      };

    };

    /// Dereferable map concept

    /// Dereferable map concept.

    ///

    template<typename K, typename T, typename R, typename CR>

    class ReferenceMap : public ReadWriteMap<K,T>

    {

    public:

      /// Tag for reference maps.

      typedef True ReferenceMapTag;

      /// The key type of the map.

      typedef K Key;

      /// The value type of the map. (The type of objects associated with the keys).

      typedef T Value;

      /// The reference type of the map.

      typedef R Reference;

      /// The const reference type of the map.

      typedef CR ConstReference;

    public:

      /// Returns a reference to the value associated with the given key.

      /// Returns a const reference to the value associated with the given key.

      /// Sets the value associated with the given key.

      void set(const Key &k,const Value &t) { operator[](k)=t; }

      template<typename _ReferenceMap>

      struct Constraints {

	void constraints() {

	  checkConcept<ReadWriteMap<K, T>, _ReferenceMap >();

	  ref = m[key];

	  m[key] = val;

	  m[key] = ref;

	  m[key] = cref;

	  own_ref = m[own_key];

	  m[own_key] = own_val;

	  m[own_key] = own_ref;

	  m[own_key] = own_cref;

	  m[key] = m[own_key];

	  m[own_key] = m[key];

	}

	const Key& key;

	Value& val;

	Reference ref;

	ConstReference cref;

	const typename _ReferenceMap::Key& own_key;

	typename _ReferenceMap::Value& own_val;

	typename _ReferenceMap::Reference own_ref;

	typename _ReferenceMap::ConstReference own_cref;

	_ReferenceMap& m;

      };

    };

    // @}

  } //namespace concepts

} //namespace lemon

#endif // LEMON_CONCEPT_MAPS_H

/* -*- C++ -*-

 *

 * This file is a part of LEMON, a generic C++ optimization library

 *

 * Copyright (C) 2003-2008

 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport

 * (Egervary Research Group on Combinatorial Optimization, EGRES).

 *

 * Permission to use, modify and distribute this software is granted

 * provided that this copyright notice appears in all copies. For

 * precise terms see the accompanying LICENSE file.

 *

 * This software is provided "AS IS" with no warranty of any kind,

 * express or implied, and with no claim as to its suitability for any

 * purpose.

 *

 */

#include <deque>

#include <set>

#include <lemon/concept_check.h>

#include <lemon/concepts/maps.h>

#include <lemon/maps.h>

#include "test_tools.h"

using namespace lemon;

using namespace lemon::concepts;

struct A {};

inline bool operator<(A, A) { return true; }

struct B {};

class F {

public:

  typedef A argument_type;

  typedef B result_type;

  B operator()(const A&) const { return B(); }

private:

  F& operator=(const F&);

};

int func(A) { return 3; }

int binc(int a, B) { return a+1; }

typedef ReadMap<A, double> DoubleMap;

typedef ReadWriteMap<A, double> DoubleWriteMap;

typedef ReferenceMap<A, double, double&, const double&> DoubleRefMap;

typedef ReadMap<A, bool> BoolMap;

typedef ReadWriteMap<A, bool> BoolWriteMap;

typedef ReferenceMap<A, bool, bool&, const bool&> BoolRefMap;

int main()

{

  // Map concepts

  checkConcept<ReadMap<A,B>, ReadMap<A,B> >();

  checkConcept<WriteMap<A,B>, WriteMap<A,B> >();

  checkConcept<ReadWriteMap<A,B>, ReadWriteMap<A,B> >();

  checkConcept<ReferenceMap<A,B,B&,const B&>, ReferenceMap<A,B,B&,const B&> >();

  // NullMap

  {

    checkConcept<ReadWriteMap<A,B>, NullMap<A,B> >();

    NullMap<A,B> map1;

    NullMap<A,B> map2 = map1;

    map1 = nullMap<A,B>();

  }

  // ConstMap

  {

    checkConcept<ReadWriteMap<A,B>, ConstMap<A,B> >();

    ConstMap<A,B> map1;

    ConstMap<A,B> map2(B());

    ConstMap<A,B> map3 = map1;

    map1 = constMap<A>(B());

    map1.setAll(B());

    checkConcept<ReadWriteMap<A,int>, ConstMap<A,int> >();

    check(constMap<A>(10)[A()] == 10, "Something is wrong with ConstMap");

    checkConcept<ReadWriteMap<A,int>, ConstMap<A,Const<int,10> > >();

    ConstMap<A,Const<int,10> > map4;

    ConstMap<A,Const<int,10> > map5 = map4;

    map4 = map5;

    check(map4[A()] == 10 && map5[A()] == 10, "Something is wrong with ConstMap");

  }

  // IdentityMap

  {

    checkConcept<ReadMap<A,A>, IdentityMap<A> >();

    IdentityMap<A> map1;

    IdentityMap<A> map2 = map1;

    map1 = identityMap<A>();

    checkConcept<ReadMap<double,double>, IdentityMap<double> >();

    check(identityMap<double>()[1.0] == 1.0 && identityMap<double>()[3.14] == 3.14,

          "Something is wrong with IdentityMap");

  }

  // RangeMap

  {

    checkConcept<ReferenceMap<int,B,B&,const B&>, RangeMap<B> >();

    RangeMap<B> map1;

    RangeMap<B> map2(10);

    RangeMap<B> map3(10,B());

    RangeMap<B> map4 = map1;

    RangeMap<B> map5 = rangeMap<B>();

    RangeMap<B> map6 = rangeMap<B>(10);

    RangeMap<B> map7 = rangeMap(10,B());

    checkConcept< ReferenceMap<int, double, double&, const double&>,

                  RangeMap<double> >();

    std::vector<double> v(10, 0);

    v[5] = 100;

    RangeMap<double> map8(v);

    RangeMap<double> map9 = rangeMap(v);

    check(map9.size() == 10 && map9[2] == 0 && map9[5] == 100,

          "Something is wrong with RangeMap");

  }

  // SparseMap

  {

    checkConcept<ReferenceMap<A,B,B&,const B&>, SparseMap<A,B> >();