Boost , Boost.Optional , Header <boost/optional/optional.hpp>

Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Detailed Semantics - Optional Values

Note

Следующий раздел содержит различные<assert()>, которые используются только для отображения постусловий в качестве примера кода. Не подразумевается, что тип<T>должен поддерживать каждое конкретное выражение, но что если выражение поддерживается, подразумевается условие.

space

<optional<T>::optional() noexcept;>

Эффект:По умолчанию конструирует<optional>.
Постусловия:<*this>являетсянеинициализированным.
Примечание:Конструктор по умолчанию Tне называется.
Пример:<
```
optional<T>def;
assert(!def);
```
>

space

<optional<T>::optional( none_t) noexcept;>

Эффект:Построение неинициализированного<optional>.
Постусловия:<*this>являетсянеинициализированным.
Примечания:<T>Конструктор по умолчаниюне называется. Выражение<boost::none>обозначает экземпляр<boost::none_t>, который может использоваться в качестве параметра.

Пример:<

#include<boost/none.hpp>
optional<T>n(none);
assert(!n);

space

<optional<T>::optional( Tconst&v)>

Требует:<is_copy_constructible<T>::value><true>.
Эффект:Непосредственно строит<optional>.
Постусловия:<*this>инициализированои его значение составляеткопия<v>.
Бросок:Все, что бросит<T::T(Tconst& )>.
Примечания:<T::T(Tconst& )>называется.
Безопасность исключения:Исключения могут быть сделаны только в течение<T::T(Tconst& );>в этом случае этот конструктор не имеет никакого эффекта.

Пример:<

Tv;
optional<T>opt(v);
assert(*opt==v);

space

<optional<T>::optional( T&& v)>

Требует:<is_move_constructible<T>::value><true>.
Эффект:Прямое перемещение конструирует<optional>.
Пост-условия:<*this>являетсяинициализированным, и его значение выводится из<v>.
Бросает:Что бросит<T::T(T&&)>.
Примечания:<T::T(T&&)>называется.
Безопасность исключения:Исключения могут быть сделаны только в течение<T::T(T&&);>в этом случае, состояние<v>определяется гарантиями безопасности исключения для<T::T(T&&)>.

Пример:<

Tv1,v2;
optional<T>opt(std::move(v1));
assert(*opt==v2);

space

<optional<T>::optional( boolcondition,Tconst&v);>

Если условие верно, то же самое, что:

<optional<T>::optional( Tconst&v)>

В противном случае, как:

<optional<T>::optional()>

space

<optional<T>::optional( optionalconst&rhs );>

Требует:<is_copy_constructible<T>::value><true>.
Эффект:Копирует<optional>.
Постусловия:Если rhs инициализируется,<*this>инициализируется и его значение составляеткопиязначения<rhs>; в противном случае<*this>неинициализируется.
Бросок:Все, что бросит<T::T(Tconst& )>.
Примечания:Если rhs инициализирован,<T::T(Tconst&)>называется.
Безопасность исключения:Исключения могут быть сделаны только в течение<T::T(Tconst& );>в этом случае этот конструктор не имеет никакого эффекта.

Пример:<

optional<T>uninit;
assert(!uninit);
optional<T>uinit2(uninit);
assert(uninit2==uninit);
optional<T>init(T(2));
assert(*init==T(2));
optional<T>init2(init);
assert(init2==init);

space

<optional<T>::optional( optional&& rhs) noexcept(>смотрите ниже<);>

Требует:<is_move_constructible<T>::value><true>.
Эффект:Перемещает<optional>.
Постусловия:Если<rhs>инициализировано,<*this>инициализируется и его значение перемещается из<rhs>; в противном случае<*this>является неинициализированным.
Бросает:Что бросит<T::T(T&&)>.
Замечания:Выражение внутри<noexcept>эквивалентно<is_nothrow_move_constructible<T>::value>.
Примечания:Если<rhs>инициализировано,<T::T(T&& )>называется.
Безопасность:Исключения могут быть выброшены только в течение<T::T(T&&);>, в этом случае<rhs>остается инициализированным, а значение<*rhs>определяется безопасностью исключения<T::T(T&&)>.

Пример:<

optional<std::unique_ptr<T>>uninit;
assert(!uninit);
optional<std::unique_ptr<T>>uinit2(std::move(uninit));
assert(uninit2==uninit);
optional<std::unique_ptr<T>>init(std::uniqye_ptr<T>(newT(2)));
assert(**init==T(2));
optional<std::unique_ptr<T>>init2(std::move(init));
assert(init);
assert(*init==nullptr);
assert(init2);
assert(**init2==T(2));

space

<template<U>explicitoptional<T>::optional(optional<U>const&rhs );>

Эффект:Копирует<optional>.
Постусловия:Если<rhs>инициализировано,<*this>инициализируется и его значение представляет собойкопиюзначения rhs, преобразованного в тип<T>; другое<*this>является неинициализированным.
Броски:Все, что<T::T(Uconst& )>бросает.
Примечания:<T::T(Uconst& )>вызывается, если<rhs>инициализируется, что требует действительного преобразования из<U>в<T>.
Безопасность исключения:Исключения могут быть сделаны только во время<T::T(Uconst& );>, в этом случае этот конструктор не имеет эффекта.

Пример:<

optional<double>x(123.4);
assert(*x==123.4);
optional<int>y(x);
assert(*y==123);

space

<template<U>explicitoptional<T>::optional(optional<U>&&rhs );>

Эффект:Перемещает<optional>.
Постусловия:Если<rhs>инициализируется,<*this>инициализируется и его значение перемещается от<*rhs>; в противном случае<*this>неинициализируется.
Бросает:Что бросит<T::T(T&&)>.
Примечания:<T::T(U&&)>вызывается, если<rhs>инициализируется, что требует действительного преобразования из<U>в<T>.
Безопасность исключения:Исключения могут быть сделаны только в течение<T::T(U&&);>, в этом случае<rhs>остается инициализированным, а значение<*rhs>определяется гарантией безопасности исключения<T::T(U&& )>.

Пример:<

optional<double>x(123.4);
assert(*x==123.4);
optional<int>y(std::move(x));
assert(*y==123);

space

<template<InPlaceFactory> explicitoptional<T>::optional(InPlaceFactory const& f);>

<template<TypedInPlaceFactory> explicitoptional<T>::optional(TypedInPlaceFactory const& f);>

Эффект:Конструирует<optional>со стоимостью<T>, полученной с завода.
Пост-условия:<*this>инициализированои его значениенепосредственно данос завода<f>(т.е. значениене скопировано).
Броски:Что бы ни бросил конструктор<T>, вызванный заводом.
Примечания:См.Заводы на местах
Безопасность исключения:Исключения могут быть сделаны только во время вызова конструктора<T>, используемого заводом; в этом случае этот конструктор не имеет эффекта.

Пример:<

classC{C(char,double,std::string);};
Cv('A',123.4,"hello");
optional<C>x(in_place ('A',123.4,"hello"));// InPlaceFactory used
optional<C>y(in_place<C>('A',123.4,"hello"));// TypedInPlaceFactory used
assert(*x==v);
assert(*y==v);

space

<optional& optional<T>::operator=(none_t )noexcept;>

Эффект:Если<*this>инициализирован, то его содержащееся значение разрушается.
<*this>является неинициализированным.

space

<optional& optional<T>::operator=(Tconst&rhs);>

Эффект:Назначает значение<rhs>на<optional>.
Последующие условия:<*this>инициализируется и его значение составляеткопия<rhs>.
Бросает:Все, что<T::operator=(Tconst& )>или<T::T(Tconst&)>бросает.
Примечание:Если<*this>было инициализировано,<T>используется оператор присвоения, в противном случае используется его копи-конструктор.
Безопасность:В случае исключения состояние инициализации<*this>остается неизменным, а его значение не определено в отношении<optional>(до<T>'s<operator=()>). Если<*this>изначально неинициализирована и<T>копировальный конструкторвыходит из строя,<*this>остается должным образом неинициализированным.

Пример:<

Tx;
optional<T>def;
optional<T>opt(x);
Ty;
def=y;
assert(*def==y);
opt=y;
assert(*opt==y);

space

<optional& optional<T>::operator=(T&&rhs );>

Эффект:Переносит значение<rhs>на<optional>.
Последующие условия:<*this>инициализируется и его значение перемещается из<rhs>.
Броски:Все, что<T::operator=(T&&)>или<T::T(T&&)>бросает.
Примечания:Если<*this>был инициализирован,<T>используется оператор назначения движения, в противном случае используется его конструктор перемещения.
Безопасность исключения:В случае исключения состояние инициализации<*this>остается неизменным, а его значение не определено в отношении<optional>(до<T>'s<operator=()>). Если<*this>изначально неинициализировано и<T>движущийся конструкторвыходит из строя,<*this>остается должным образом неинициализированным.

Пример:<

Tx;
optional<T>def;
optional<T>opt(x);
Ty1,y2,yR;
def=std::move(y1);
assert(*def==yR);
opt=std::move(y2);
assert(*opt==yR);

space

<optional& optional<T>::operator=(optional const& rhs) ;>

Требует:<T>является<CopyConstructible>и<CopyAssignable>.
Эффекты:

Tv; optional<constT>opt; opt.emplace(0);// create in-place using ctor T(int) opt.emplace(); // destroy previous and default-construct another T opt.emplace(v);// destroy and copy-construct in-place (no assignment called)

intcomplain_and_0() { clog<<"no value returned, using default"<<endl; return0; } optional<int>o1=1; optional<int>oN=none; inti=o1.value_or_eval(complain_and_0);// fun not called assert(i==1); intj=oN.value_or_eval(complain_and_0);// fun called assert(i==0);