clanguml::common::model::tvl Namespace Reference

Detailed Description

This namespace implements convenience functions to handle 3-value logic operations needed for applying diagram filters.

See also

clanguml::common::model::diagram_filter

clanguml::common::model::filter_visitor

Typedefs
using	value_t = std::optional< bool >

Functions
value_t	and_ (const value_t &l, const value_t &r)
value_t	or_ (const value_t &l, const value_t &r)
bool	is_true (const value_t &v)
bool	is_false (const value_t &v)
bool	is_undefined (const value_t &v)
template<typename InputIterator , typename Predicate >
value_t	all_of (InputIterator first, InputIterator last, Predicate pred)
template<typename InputIterator , typename Predicate >
value_t	any_of (InputIterator first, InputIterator last, Predicate pred)

Typedef Documentation

value_t

using clanguml::common::model::tvl::value_t = typedef std::optional<bool>

Alias for 3-value logic values

If optional holds nullopt, the value is undefined.

Definition at line 37 of file tvl.h.

Function Documentation

all_of()

template<typename InputIterator , typename Predicate >

value_t clanguml::common::model::tvl::all_of ( InputIterator  first, InputIterator  last, Predicate  pred  )

inline

3-value logic equivalent of std::all_of

Template Parameters

InputIterator	Iterator type
Predicate	Predicate type

Parameters

first	First iterator element
last	Last iterator element
pred	Predicate to apply to each element

Returns

True, if all elements are true or undefined

Definition at line 113 of file tvl.h.

{
    value_t res{};
 
    for (InputIterator it = first; it != last; it++) {
        value_t m = pred(*it);
        if (m.has_value()) {
            if (m.value()) {
                res = true;
            }
            else {
                res = false;
                break;
            }
        }
    }
 
    return res;
}

and_()

value_t clanguml::common::model::tvl::and_ ( const value_t &  l, const value_t &  r  )

inline

Calculate 3-value logic AND value.

Parameters

l	Left value
r	Right value

Returns

Result of AND operation.

Definition at line 46 of file tvl.h.

{
    if (!l.has_value())
        return r;
 
    if (!r.has_value())
        return l;
 
    return r.value() && l.value();
}

any_of()

template<typename InputIterator , typename Predicate >

value_t clanguml::common::model::tvl::any_of ( InputIterator  first, InputIterator  last, Predicate  pred  )

inline

3-value logic equivalent of std::any_of

Template Parameters

InputIterator	Iterator type
Predicate	Predicate type

Parameters

first	First iterator element
last	Last iterator element
pred	Predicate to apply to each element

Returns

True, if at least 1 element is true

Definition at line 144 of file tvl.h.

{
    value_t res{};
 
    for (InputIterator it = first; it != last; it++) {
        value_t m = pred(*it);
        if (m.has_value()) {
            if (m.value()) {
                res = true;
                return res;
            }
            res = false;
        }
    }
 
    return res;
}

is_false()

bool clanguml::common::model::tvl::is_false ( const value_t &  v )

inline

Whether the value holds false

Parameters

v	Logical value

Returns

True, if v holds false

Definition at line 92 of file tvl.h.

{ return v.has_value() && !v.value(); }

is_true()

bool clanguml::common::model::tvl::is_true ( const value_t &  v )

inline

Whether the value holds true

Parameters

v	Logical value

Returns

True, if v holds true

Definition at line 84 of file tvl.h.

{ return v.has_value() && v.value(); }

is_undefined()

bool clanguml::common::model::tvl::is_undefined ( const value_t &  v )

inline

Whether the value is undefined

Parameters

v	Logical value

Returns

True, if v has no value

Definition at line 100 of file tvl.h.

{ return !v.has_value(); }

or_()

value_t clanguml::common::model::tvl::or_ ( const value_t &  l, const value_t &  r  )

inline

Calculate 3-value logic OR value.

Parameters

l	Left value
r	Right value

Returns

Result of OR operation.

Definition at line 64 of file tvl.h.

{
    if (!l.has_value() && !r.has_value())
        return {};
 
    if (l.has_value() && l.value())
        return true;
 
    if (r.has_value() && r.value())
        return true;
 
    return false;
}