alg Namespace Reference

Functions
template<typename _Type , typename _Function >
void	run_on_pair (std::pair< _Type, _Type > &__pair, _Function __f)
	Apply a function to the first and second element of a std::pair. More...
template<typename _InputIterator , typename _Function >
void	adjacent_pairs (_InputIterator __first, _InputIterator __last, _Function __f)
	Apply a function to every sequential pair of elements of a sequence. More...
template<typename _InputIterator , typename _Function >
void	for_all_pairs (_InputIterator __first, _InputIterator __last, _Function __f)
	Apply a function to every possible pair of elements of a sequence. More...
template<class _Container , typename _Value >
bool	contains (const _Container &__container, _Value __value)
	Returns true if the container contains the given value. More...
template<typename _Type , typename _Value >
bool	pair_contains (const std::pair< _Type, _Type > __pair, _Value __value)
	Returns true if either of the elements in an std::pair contains the given value. More...
template<class T >
bool	within_wrapped_range (T __val, T __minval, T __maxval, T __wrap)
	Test if __val lies within __minval and __maxval in a wrapped range. More...

Function Documentation

adjacent_pairs()

template<typename _InputIterator , typename _Function >

void alg::adjacent_pairs	(	_InputIterator	__first,
		_InputIterator	__last,
		_Function	__f
	)

Apply a function to every sequential pair of elements of a sequence.

Parameters

__first	An input iterator.
__last	An input iterator.
__f	A unary function object.

Applies the function object __f to each sequential pair of elements in the range [first,last). __f must not modify the order of the sequence. If __f has a return value it is ignored.

Definition at line 61 of file kicad_algo.h.

{
    if( __first != __last )
    {
        _InputIterator __follow = __first;
        ++__first;
        for( ; __first != __last; ++__first, ++__follow )
            __f( *__follow, *__first );
    }
}

contains()

template<class _Container , typename _Value >

bool alg::contains	(	const _Container &	__container,
		_Value	__value
	)

Returns true if the container contains the given value.

Definition at line 99 of file kicad_algo.h.

{
    return std::find( __container.begin(), __container.end(), __value ) != __container.end();
}

Referenced by PROJECT_TREE_PANE::addItemToProjectTree(), BOARD::AddListener(), BUS_ALIAS::Contains(), PNS::ITEM_SET::Contains(), CN_CLUSTER::Contains(), PNS::LINK_HOLDER::ContainsLink(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_TOOL::DoDelete(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), GRAPHICS_IMPORT_MGR::GRAPHICS_IMPORT_MGR(), SYMBOL_EDIT_FRAME::HardRedraw(), DIALOG_EXPORT_SVG::initDialog(), TOOL_MANAGER::isActive(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), PNS::TOOL_BASE::pickSingleItem(), PCB_CONTROL::placeBoardItems(), DIALOG_CHANGE_SYMBOLS::processSymbol(), EE_SELECTION_TOOL::RemoveItemsFromSel(), PCB_SELECTION_TOOL::selectAllItemsOnSheet(), and DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow().

for_all_pairs()

template<typename _InputIterator , typename _Function >

void alg::for_all_pairs	(	_InputIterator	__first,
		_InputIterator	__last,
		_Function	__f
	)

Apply a function to every possible pair of elements of a sequence.

Parameters

__first	An input iterator.
__last	An input iterator.
__f	A unary function object.

Applies the function object __f to every possible pair of elements in the range [first,last). __f must not modify the order of the sequence. If __f has a return value it is ignored.

Definition at line 83 of file kicad_algo.h.

{
    if( __first != __last )
    {
        _InputIterator __follow = __first;
        ++__first;
        for( ; __first != __last; ++__first, ++__follow )
            for( _InputIterator __it = __first; __it != __last; ++__it )
                __f( *__follow, *__it );
    }
}

Referenced by SCH_EDIT_FRAME::DeleteJunction(), and SCH_EDIT_FRAME::SchematicCleanUp().

pair_contains()

template<typename _Type , typename _Value >

bool alg::pair_contains	(	const std::pair< _Type, _Type >	__pair,
		_Value	__value
	)

Returns true if either of the elements in an std::pair contains the given value.

Parameters

__pair	A pair of elements (both elements must be the same type).
__value	A value to test

Returns

true if __value is contained in __pair

Definition at line 112 of file kicad_algo.h.

{
    return __pair.first == static_cast<_Type>( __value )
           || __pair.second == static_cast<_Type>( __value );
}

Referenced by SHAPE_LINE_CHAIN::NextShape().

run_on_pair()

template<typename _Type , typename _Function >

void alg::run_on_pair	(	std::pair< _Type, _Type > &	__pair,
		_Function	__f
	)

Apply a function to the first and second element of a std::pair.

Parameters

__pair	A pair of elements (both elements must be the same type).
__f	A unary function object.

Applies the function object __f to __pair.first and __pair.second If __f has a return value it is ignored.

Definition at line 44 of file kicad_algo.h.

{
    __f( __pair.first );
    __f( __pair.second );
}

Referenced by SHAPE_LINE_CHAIN::Append(), SHAPE_LINE_CHAIN::convertArc(), SHAPE_LINE_CHAIN::Insert(), SHAPE_LINE_CHAIN::Remove(), SHAPE_LINE_CHAIN::Replace(), SHAPE_LINE_CHAIN::Reverse(), SHAPE_LINE_CHAIN::SetPoint(), and SHAPE_LINE_CHAIN::splitArc().

within_wrapped_range()

template<class T >

bool alg::within_wrapped_range	(	T	__val,
		T	__minval,
		T	__maxval,
		T	__wrap
	)

Test if __val lies within __minval and __maxval in a wrapped range.

Parameters

__val	A value to test
__minval	Lowest permissible value within the wrapped range
__maxval	Highest permissible value within the wrapped range
__wrap	Value at which the range wraps around itself (must be positive)

Returns

true if __val lies in the wrapped range

Definition at line 128 of file kicad_algo.h.

{
    wxCHECK_MSG( __wrap > 0, false, "Wrap must be positive!" );

    while( __maxval >= __wrap )
        __maxval -= __wrap;

    while( __maxval < 0 )
        __maxval += __wrap;

    while( __minval >= __wrap )
        __minval -= __wrap;

    while( __minval < 0 )
        __minval += __wrap;

    while( __val < 0 )
        __val += __wrap;

    while( __val >= __wrap )
        __val -= __wrap;

    if( __maxval > __minval )
        return __val >= __minval && __val <= __maxval;
    else
        return __val >= __minval || __val <= __maxval;
}

Referenced by SHAPE_ARC::sliceContainsPoint().