Законные побочные эффекты: пример

Закончим обсуждение побочных эффектов рассмотрением законного побочного эффекта - функции, не меняющей абстрактного состояния, но изменяющей конкретное состояние, и по вполне разумным причинам. Этот пример достаточно представителен и представляет некоторый шаблон проектирования.

Рассмотрим реализацию комплексных чисел. Как и в случае с точками, обсуждаемом в предыдущих лекциях, возможны два представления - декартово (с координатами x и y ) и полярное (с расстоянием r и углом q ). Какое из них выбрать? Простого ответа нет. Если, как обычно, обратиться к АТД, то разные применимые операции - сложение, вычитание, умножение и деление - и запросы для получения значений x, y, r и q эффективно выполняются для разных представлений (декартово представление лучше для сложения и умножения, полярное - для умножений и делений).

Можно было бы позволить клиенту решать, какое выбрать представление, но это делает классы трудными в использовании и нарушает принцип скрытия информации от клиента, которому нет дела до представления.

Альтернативой является одновременное хранение двух представлений. Но это приводит к издержкам производительности. Предположим, что клиенту требуются только операции умножения и деления. В этом случае операции используют только полярное представление, но мы бы каждый раз вычисляли бы x и y, выполняя бесполезные и дорогие вычисления.

Лучшее решение состоит в отказе от априорного выбора, выполняя выбор при необходимости. Мы практически ничего не проигрываем по памяти - все атрибуты нам все равно нужны, к ним добавятся только два булевых атрибута, указывающих на выбор текущего представления, но это позволит избежать лишних вычислений.

Пусть наш класс включает следующие операции:

class COMPLEX feature

... Объявления компонентов:

infix "+", infix "-", infix "*", infix "/",

add, subtract, multiply, divide,

x, y, rho, theta, ...

end

Запросы x, y, rho и theta представляют экспортируемые функции, возвращающие вещественные значения. Они всегда определены (исключая theta для комплексного числа 0 ). Помимо инфиксных функций " + " и других предполагаем процедуру add и другие. Вызов: z1 + z2 дает новое комплексное число, вызов z1.add (z2) изменяет z1. На практике могут понадобиться только функции или только процедуры.

Наш класс включает следующие секретные (закрытые) атрибуты:

cartesian_ready: BOOLEAN

polar_ready: BOOLEAN

private_x, private_y, private_rho, private_theta: REAL

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

invariant

cartesian_ready or polar_ready

polar_ready implies (0 <= private_theta and private_theta <= Two_pi)

-- cartesian_ready implies (private_x and private_y являются текущими)

-- polar_ready implies (private_rho and private_theta являются текущими)

Последние два предложения выражены неформально в форме комментария.

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

Две закрытые процедуры доступны для проведения изменений представления:

prepare_cartesian is

-- Сделать доступным декартово представление

do

if not cartesian_ready then

check polar_ready end

-- Поскольку инвариант требует, чтобы одно

-- из двух представлений было текущим

private_x := private_rho * cos (private_theta)

private_y := private_rho * sin (private_theta)

cartesian_ready := True

-- Здесь cartesian_ready и polar_ready равны true:

-- Оба представления являются текущими

end

ensure

cartesian_ready

end

prepare_polar is

-- Сделать доступным полярное представление

do

if not polar_ready then

check cartesian_ready end

private_rho := sqrt (private_x ^ 2 + private_y ^ 2)

private_theta := atan2 (private_y, private_x)

polar_ready := True

-- Здесь cartesian_ready и polar_ready равны true:

-- Оба представления являются текущими

end

ensure

polar_ready

end

Функции cos, sin, sqrt и atan2 берутся из стандартной математической библиотеки, atan2(y, x) вычисляетarctangent(y/x).

Нам также нужны процедуры создания - make_cartesian и make_polar:

make_cartesian (a, b: REAL) is

-- Инициализация: abscissa a, ordinate b

do

private_x := a; private_y := b

cartesian_ready := True; polar_ready := False

ensure

cartesian_ready; not polar_ready

end

и симметрично для make_polar.

Экспортируемые операции пишутся просто, начнем, например, с процедуры, имеющей варианты в зависимости от операции:

add (other: COMPLEX) is

-- Добавляет значение other

do

prepare_cartesian; polar_ready := False

private_x := x + other.x; private_y = y + other.y

ensure

x = old x + other.x; y = old y + other.y

cartesian_ready; not polar_ready

end

Заметьте, в постусловии важно использовать x и y, а не private_x и private_y, которые могут не быть текущими перед вызовом.

divide (z: COMPLEX) is

-- Divide by z.

require

z.rho /= 0

-- Численное выражение дает более реалистичное предусловие

do

prepare_polar; cartesian_ready := False

private_rho := rho / other.rho

private_theta = (theta - other.theta) \\ Two_pi

-- \\ - остаток от деления

ensure

rho = old rho / other.rho

theta = (old theta - other.theta) \\ Two_pi

polar_ready; not cartesian_ready

end

Аналогично для вычитания и умножения - subtract и multiply. (Предусловие и постусловие могут быть слегка адаптированы для учета особенностей операций с плавающей точкой.) Варианты функций следуют тому же образцу:

infix "+" (other: COMPLEX): COMPLEX is

-- Сумма текущего числа и other

do

create Result.make_cartesian (x + other.x, y + other.y)

ensure

Result.x = x + other.x; Result.y = y + other.y

Result.cartesian_ready

end

infix "/" (z: COMPLEX): COMPLEX is

-- Частное от деления текущего комплексного числа на z

require

z.rho /= 0

do

create Result.make_polar (rho / other.rho, (theta - other.theta) \\ Two_pi)

ensure

Result.rho = rho / other.rho

Result.theta = (old theta - other.theta) \\ Two_pi

Result.polar_ready

end

Аналогично для infix "-" и infix "**".

Но где здесь побочные эффекты? В последних двух функциях они непосредственно не видны. Все дело в x, y, rho и theta- они являются хитроумными создателями побочных эффектов. Вычисление x или y приведет к изменению представления (вызовется prepare_cartesian ), если не подготовлено декартово представление. Все симметрично для rho и theta. Вот примеры для x и theta:

x: REAL is

-- Abscissa

do

prepare_cartesian; Result := private_x

end

theta: REAL is

-- Angle

do

prepare_polar; Result := private_theta

end

Функции y и rho подобны. Все эти функции вызывают процедуру, которая может включить изменение состояния. В отличие отadd и его собратьев, однако, они не делают предыдущее представление неверным, когда вычисляется новое представление. Например, если x вызывается в состоянии с ложным значением cartesian_ready, оба представления (все четыре вещественных атрибута) станут текущими. Все это потому, что функциям разрешается производить побочные эффекты только на конкретных объектах, но не на ассоциированных абстрактных объектах. Выразим это свойство более формально: вычислениеz.x или другой функции может изменять конкретный объект, связанный с z, скажем от c₁ до c₂, но всегда с гарантией того, что

a(c₁) = a(c₂)

где a - абстрактная функция. Объекты c₁ и c₂ могут быть различными, но они представляют один и тот же математический объект - комплексное число.

Такие побочные эффекты безвредны. Они действуют только на секретные атрибуты и, следовательно, не могут быть обнаружены клиентами.

ОО-подход поощряет такие гибкие, адаптирующиеся схемы, выбирающие наилучшее представление, соответствующее потребностям текущего момента. Пока реализация действует на конкретное состояние, не затрагивая абстрактного, ее функции не нарушают Принципа Разделения и не создают угрозу ссылочной прозрачности.