MonotoneBoundedVector.h

Go to the documentation of this file.

/***************************************************************************
 *
 * Copyright (C) 2009-2011 Cassio Neri Moreira
 *
 * This file is part of the KeyValue library.
 *
 * The KeyValue library 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.
 *
 * The KeyValue 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 General
 * Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with KeyValue. If not, see <http://www.gnu.org/licenses/>.
 *
 * If you modify this library, or any covered work, by linking or combining
 * it with Excel (or a modified version of that program), containing parts
 * covered by the terms of End-User License Agreement for Microsoft
 * Software, the licensors of KeyValue grant you additional permission to
 * convey the resulting work.
 *
 **************************************************************************/

#ifndef KEYVALUE_KEY_GENERIC_MONOTONEBOUNDEDVECTOR_H_
#define KEYVALUE_KEY_GENERIC_MONOTONEBOUNDEDVECTOR_H_

#include "keyvalue/key/converter/StdVector.h"
#include "keyvalue/key/generic/bound/NoBound.h"
#include "keyvalue/key/Traits.h"

namespace keyvalue {
namespace key {

template <typename ElementType, typename Monotone,
  template <typename> class Bound1 = NoBound,
  template <typename> class Bound2 = NoBound>
class MonotoneBoundedVector: public Traits<ElementType, StdVector, NoMap> {

public:

  explicit
  MonotoneBoundedVector(const string& name, size_t size = 0);

  MonotoneBoundedVector(const string& name, const ElementType& bound1,
    size_t size = 0);

  MonotoneBoundedVector(const string& name, const ElementType& bound1,
    const ElementType& bound2, size_t size = 0);

  void
  checkSoFar(const StdVector<ElementType>& container) const;

  void
  checkSize(size_t size) const;

private:

  const size_t              size_;
  const Bound1<ElementType> bound1_;
  const Bound2<ElementType> bound2_;

}; // class MonotoneBoundedVector

/*--------------------------------------------------------------------------
 * MonotoneBoundedVector()
 *------------------------------------------------------------------------*/

template <typename ElementType, typename Monotone,
  template <typename> class Bound1, template <typename> class Bound2>
MonotoneBoundedVector<ElementType, Monotone, Bound1,
  Bound2>::MonotoneBoundedVector(const string& name, size_t size) :
  MonotoneBoundedVector::Traits_(name),
  size_(size),
  bound1_(),
  bound2_() {
}

template <typename ElementType, typename Monotone,
  template <typename> class Bound1, template <typename> class Bound2>
MonotoneBoundedVector<ElementType, Monotone, Bound1,
  Bound2>::MonotoneBoundedVector(const string& name,
  const ElementType& bound1, size_t size) :
  MonotoneBoundedVector::Traits_(name),
  size_(size),
  bound1_(bound1),
  bound2_() {
}

template <typename ElementType, typename Monotone,
  template <typename> class Bound1, template <typename> class Bound2>
MonotoneBoundedVector<ElementType, Monotone, Bound1,
  Bound2>::MonotoneBoundedVector(const string& name,
  const ElementType& bound1, const ElementType& bound2, size_t size) :
  MonotoneBoundedVector::Traits_(name),
  size_(size),
  bound1_(bound1),
  bound2_(bound2) {
}

/*--------------------------------------------------------------------------
 * checkSoFar()
 *------------------------------------------------------------------------*/

template <typename ElementType, typename Monotone,
  template <typename> class Bound1, template <typename> class Bound2>
void
MonotoneBoundedVector<ElementType, Monotone, Bound1, Bound2>::checkSoFar(
  const StdVector<ElementType>& container) const {

  const vector<ElementType>& vector(*container.getOutput());
  const size_t size(vector.size());

  // Check monotonicity
  if (size > 1 && !Monotone::check(vector[size-2], vector[size-1]))
    throw RuntimeError() & "Values for key '" & Key::getName() &
      "' must be in " & Monotone::getName() & " order. Got " &
      vector[size-2] & " followed by " & vector[size-1] & "!";

  // Check boundness
  if (!bound1_.check(vector.back()))
    throw RuntimeError() & "Value for key '" & Key::getName() & "' must "
      "be " & bound1_.getName() & " " & bound1_.getBound() & ". Got " &
      vector.back() & "!";

  if (!bound2_.check(vector.back()))
    throw RuntimeError() & "Value for key '" & Key::getName() & "' must "
      "be " & bound2_.getName() & " " & bound2_.getBound() & ". Got " &
      vector.back() & "!";
}

/*--------------------------------------------------------------------------
 * checkSize()
 *------------------------------------------------------------------------*/

template <typename ElementType, typename Monotone,
  template <typename> class Bound1, template <typename> class Bound2>
void
MonotoneBoundedVector<ElementType, Monotone, Bound1, Bound2>::checkSize(
  size_t size) const {

  if (size_ != 0 && size_ != size)
    throw RuntimeError() & "Invalid number of values assigned to key '" &
      Key::getName() & "'! Expecting " & size_ & " got " & size & "!";
}

} // namespace key
} // namespace keyvalue

#endif // KEYVALUE_KEY_GENERIC_MONOTONEBOUNDEDVECTOR_H_