5.6. Определение ограниченных типов значений

5.6. Определение ограниченных типов значений

Проблема

Требуются самопроверяющиеся типы числовых данных, представляющие числа в ограниченном диапазоне допустимых значений, гаком как часы в сутках или минуты в часе.

Решение

При работе с датами и временем часто возникает необходимость ограничить целые значения диапазоном допустимых значений (т.е для секунд в минуте — от 0 до 59, для часов в сутках от 0 до 23, для дней в году — от 0 до 365). Вместо того чтобы каждый раз проверять эти значения при их передаче в функцию, предпочтительной является их автоматическая проверка с помощью перегруженного оператора присвоения. Так как имеется очень большое количество таких типов, следует реализовать один тип, который сможет работать с подобной проверкой для различных числовых диапазонов. Пример 5.10 представляет реализацию шаблона класса ConstrаinedValue, который облегчает задание диапазона целых чисел и определение других ограниченных типов.

Пример 5.10. constrained_value.hpp

#ifndef CONSTRAINED_VALUE_HPP

#define CONSTRAINED_VALUE_HPP

#include <cstdlib>

#include <iostream>

using namespace std;

template<class Policy_T>

struct ConstrainedValue {

public:

 // открытые typedef

 typedef typename Policy_T policy_type;

 typedef typename Policy_T::value_type value_type;

 typedef ConstrainedValue self;

 // конструктор по умолчанию

 ConstrainedValue() : m(Policy_T::default_value) {}

 ConstrainedValue(const self& x) : m(x.m) {}

 ConstrainedValue(const value_type& x) { Policy_T::assign(m, x); }

 operator value_type() const { return m; }

 // использует функцию присвоения, определенную политикой

 void assign(const value_type& x) {

  Policy_T::assign(m, x);

 }

 // операции присвоения

 self& operator=(const value_type& x) { assign(x); return *this; }

 self& operator+=(const value_type& x) { assign(m + x) return *this; }

 self& operator-=(const value_type& x) { assign(m - x) return *this; }

 self& operator*=(const value_type& x) { assign(m * x); return *this; }

 self& operator/=(const value_type& x) { assign(m / x); return *this; }

 self& operator%=(const value_type& x) { assign(m % x); return *this; }

 self& operator>>=(int x) { assign(m >> x); return *this; }

 self& operator<<=(int x) { assign(m << x); return *this; }

 // унарные операторы

 self operator-() { return self(-m); }

 self operator+() { return self(-m); }

 self operator!() { return self(!m); }

 self operator~() { return self(~m); }

 // бинарные операторы

 friend self operator+(self x, const value_type& y) { return x += y; }

 friend self operator-(self x, const value_type& y) { return x -= y; }

 friend self operator*(self x, const value_type& y) { return x *= y; }

 friend self operator/{self x, const value_type& y) { return x /= y; }

 friend self operator%(self x, const value_type& y) { return x %= y; }

 friend self operator+(const value_type& y, self x) { return x += y; }

 friend self operator-(const value_type& y, self x) { return x -= y; }

 friend self operator*(const value_type& y, self x) { return x *= y; }

 friend self operator/(const value_type& y, self x) { return x /= y; }

 friend self operator%(const value_type& y, self x) { return x %= y; }

 friend self operator>>(self x, int y) { return x >>= y; }

 friend self operator<<(self x, int y) { return x <<= y; }

 // потоковые операторы

 friend ostream& operator<<(ostream& o, self x) { о << x.m; return o; }

 friend istream& operator>>(istream& i, self x) {

  value_type tmp; i >> tmp; x.assign(tmp); return i;

 }

 // операторы сравнения

 friend bool operator<(const self& x, const self& y) { return x.m < y.m; }

 friend bool operator>(const self& x, const self& y) { return x.m > y.m; }

 friend bool operator<=(const self& x, const self& y) { return x.m <= y.m; }

 friend bool operator>=(const self& x, const self& y) { return x.m >= y.m; }

 friend bool operator==(const self& x, const self& y) { return x.m == y.m; }

 friend bool operator!=(const self& x, const self& y) { return x.m != y.m; }

private:

 value_type m;

};

template<int Min_N, int Max_N>

struct RangedIntPolicy {

 typedef int value_type;

 const static value_type default_value = Min_N;

 static void assign(value_type& lvalue, const value_type& rvalue) {

  if ((rvalue < Min_N) || (rvalue > Max_N) {

   throw range_error("out of valid range");

  }

  lvalue = rvalue;

 }

};

#endif

Программа в примере 5.11 показывает, как использовать тип ConstrainedValue.

Пример 5.11. Использование constrained_value.hpp

#include "constrained_value.hpp"

typedef ConstrainedValue< RangedIntPolicy<1582, 4000> > GregYear;

typedef ConstrainedValue< RangedIntPolicy<1, 12> > GregMonth;

typedef ConstrainedValue< RangedIntPolicy<1, 31> > GregDayOfMonth;

using namespace std;

void gregOutputDate(GregDayOfMonth d, GregMonth m, GregYear y) {

 cout << m << "/" << d << "/" << y << endl;

}

int main() {

 try {

  gregOutputDate(14, 7, 2005);

 } catch(...) {

  cerr << "Оп, не должны сюда попасть << endl;

 }

 try {

  gregOutputDate(1, 5, 1148);

  cerr << "Оп, не должны сюда попасть" << endl;

 } catch(...) {

  cerr << "Уверены, что надо использовать григорианский календарь?" << endl;

 }

}

Вывод программы из примера 5.11 имеет вид:

7/14/2005

Уверены, что надо использовать григорианский календарь?

Обсуждение

Ограниченные типы значений обычно используются при работе с датами и временем, так как многие значения, связанные с датами/временем, — это целые числа, которые должны находиться в определенных диапазонах (например, месяц должен быть в интервале [0,11], а день месяца должен быть в интервале [0,30]). Проверять вручную параметр каждой функции на допустимый диапазон очень долго и чревато ошибками. Просто представьте, что требуется внести глобальное изменение в то, как программа, содержащая миллион строк кода, обрабатывает ошибки диапазона дат!

Шаблон класса ConstrainedValue, используемый вместе с шаблоном RangedIntPolicy, может использоваться для простого определения различных типов, выбрасывающих при присвоении значений, выходящих за диапазон, исключения. Пример 5.12 показывает некоторые примеры использования ConstrainedValue для определения новых самопроверяющихся целочисленных типов.

Пример 5.12. Использование ConstrainedValue

typedef ConstrainedValue< RangedIntPolicy <0, 59> > Seconds;

typedef ConstrainedValue< RangedIntPolicy <0, 59> > Minutes;

typedef ConstrainedValue< RangedIntPolicy <0, 23> > Hours;

typedef ConstrainedValue< RangedIntPolicy <0, 30> > MonthDays;

typedef ConstrainedValue< RangedIntPolicy <0, 6> > WeekDays;

typedef ConstrainedValue< RangedIntPolicy <0, 365> > YearDays;

typedef ConstrainedValue< RangedIntPolicy <0, 51> > Weeks.

Шаблон класса ConstrainedValue является примером основанного на политике дизайна. Политика — это класс, передаваемый в шаблон как параметр, который указывает аспекты реализации или поведения параметризованного класса. Политика, передаваемая в ConstrainedValue, должна предоставлять реализацию того, как выполнять присвоение между одними и теми же специализациями типа.

Использование политик может повысить гибкость классов, перенеся часть решений относительно типа на его пользователя. Политики обычно используются тогда, когда группа типов имеет общий интерфейс, но различается по реализациям. Также политики частично полезны при невозможности предугадать и удовлетворить все возможные сценарии использования данного типа.

Имеется множество других политик, которые можно использовать с типом ConstrainedValue. Например, вместо того чтобы выбрасывать исключение, можно присваивать значение по умолчанию или ближайшее допустимое значение. Более того, ограничения не обязательно должны иметь вид диапазонов: можно задать такое ограничение, когда значение всегда должно быть четным.