kicad/include/core/kicad_algo.h

182 lines
5.8 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2019 CERN
* Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.TXT for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-3.0.html
* or you may search the http://www.gnu.org website for the version 3 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef INCLUDE_CORE_KICAD_ALGO_H_
#define INCLUDE_CORE_KICAD_ALGO_H_
#include <algorithm>
#include <functional> // std::function
#include <utility> // std::pair
#include <wx/debug.h> // wxCHECK_MSG
namespace alg
{
/**
* @brief Apply a function to the first and second element of a std::pair
* @param __pair A pair of elements (both elements must be the same type).
* @param __f A unary function object.
*
* Applies the function object @p __f to @p __pair.first and @p __pair.second
* If @p __f has a return value it is ignored.
*/
template <typename _Type, typename _Function>
void run_on_pair( std::pair<_Type, _Type>& __pair, _Function __f )
{
__f( __pair.first );
__f( __pair.second );
}
/**
* @brief Apply a function to every sequential pair of elements of a sequence.
* @param __first An input iterator.
* @param __last An input iterator.
* @param __f A unary function object.
*
* Applies the function object @p __f to each sequential pair of elements in the range
* @p [first,last). @p __f must not modify the order of the sequence.
* If @p __f has a return value it is ignored.
*/
template <typename _InputIterator, typename _Function>
void adjacent_pairs( _InputIterator __first, _InputIterator __last, _Function __f )
{
if( __first != __last )
{
_InputIterator __follow = __first;
++__first;
for( ; __first != __last; ++__first, ++__follow )
__f( *__follow, *__first );
}
}
/**
* @brief Apply a function to every possible pair of elements of a sequence.
* @param __first An input iterator.
* @param __last An input iterator.
* @param __f A unary function object.
*
* Applies the function object @p __f to every possible pair of elements in the range
* @p [first,last). @p __f must not modify the order of the sequence.
* If @p __f has a return value it is ignored.
*/
template <typename _InputIterator, typename _Function>
void for_all_pairs( _InputIterator __first, _InputIterator __last, _Function __f )
{
if( __first != __last )
{
_InputIterator __follow = __first;
++__first;
for( ; __first != __last; ++__first, ++__follow )
for( _InputIterator __it = __first; __it != __last; ++__it )
__f( *__follow, *__it );
}
}
/**
* @brief Returns true if the container contains the given value.
*/
template <class _Container, typename _Value>
bool contains( const _Container& __container, _Value __value )
{
return std::find( __container.begin(), __container.end(), __value ) != __container.end();
}
/**
* @brief Returns true if either of the elements in an std::pair contains the given value
*
* @param __pair A pair of elements (both elements must be the same type).
* @param __value A value to test
* @return true if @p __value is contained in @p __pair
*/
template <typename _Type, typename _Value>
bool pair_contains( const std::pair<_Type, _Type> __pair, _Value __value )
{
return __pair.first == static_cast<_Type>( __value )
|| __pair.second == static_cast<_Type>( __value );
}
/**
* @brief Test if __val lies within __minval and __maxval in a wrapped range.
*
* @param __val A value to test
* @param __minval Lowest permissible value within the wrapped range
* @param __maxval Highest permissible value within the wrapped range
* @param __wrap Value at which the range wraps around itself (must be positive)
* @return true if @p __val lies in the wrapped range
*/
template <class T>
bool within_wrapped_range( T __val, T __minval, T __maxval, T __wrap )
{
wxCHECK_MSG( __wrap > 0, false, wxT( "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;
}
/**
* Covers for the horrifically named std::remove and std::remove_if (neither of which remove
* anything).
*/
/**
* @brief Deletes all values from \a __c which match \a __value.
*/
template <class _Container, typename _Value>
void delete_matching( _Container& __c, _Value __value )
{
__c.erase( std::remove( __c.begin(), __c.end(), __value ), __c.end() );
}
/**
* @brief Deletes all values from \a __c for which \a __f returns true.
*/
template <class _Container, class _Function>
void delete_if( _Container& __c, _Function&& __f )
{
__c.erase( std::remove_if( __c.begin(), __c.end(), std::forward<_Function>( __f ) ), __c.end() );
}
} // namespace alg
#endif /* INCLUDE_CORE_KICAD_ALGO_H_ */