kicad_algo.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019 CERN
 * Copyright (C) 2019-2023 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
{
template <typename _Type, typename _Function>
void run_on_pair( std::pair<_Type, _Type>& __pair, _Function __f )
{
 __f( __pair.first );
 __f( __pair.second );
}
 
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 );
 }
}
 
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 );
 }
}
 
template <class _Container, typename _Value>
bool contains( const _Container& __container, _Value __value )
{
 return std::find( __container.begin(), __container.end(), __value ) != __container.end();
}
 
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 );
}
 
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;
}
 
template <class _Container, typename _Value>
void delete_matching( _Container& __c, _Value __value )
{
 __c.erase( std::remove( __c.begin(), __c.end(), __value ), __c.end() );
}
 
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() );
}
 
template <class _Container>
void remove_duplicates( _Container& __c )
{
 __c.erase( std::unique( __c.begin(), __c.end() ), __c.end() );
}
 
template <class _Container, class _Function>
void remove_duplicates( _Container& __c, _Function&& __f )
{
 __c.erase( std::unique( __c.begin(), __c.end(), std::forward<_Function>( __f ) ), __c.end() );
}
 
template <typename T, std::enable_if_t<std::is_integral<T>::value, int> = 0>
bool signbit( T v )
{
 return v < 0;
}
 
 
template <typename T>
T clamp( T min, T value, T max )
{
 return std::max( min, std::min( value, max ) );
}
 
 
} // namespace alg
 
#endif /* INCLUDE_CORE_KICAD_ALGO_H_ */