/* ///////////////////////////////////////////////////////////////////////// * File: stlsoft/algorithms/collection.hpp * * Purpose: Whole collection algorithms. * * Created: 17th January 2002 * Updated: 10th August 2009 * * Home: http://stlsoft.org/ * * Copyright (c) 2002-2009, Matthew Wilson and Synesis Software * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * - Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * - Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of * any contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * * ////////////////////////////////////////////////////////////////////////// */ /** \file stlsoft/algorithms/collection.hpp * * \brief [C++ only] Whole collection algorithms * (\ref group__library__algorithms "Algorithms" Library). */ #ifndef STLSOFT_INCL_STLSOFT_ALGORITHMS_HPP_COLLECTION #define STLSOFT_INCL_STLSOFT_ALGORITHMS_HPP_COLLECTION #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION # define STLSOFT_VER_STLSOFT_ALGORITHMS_HPP_COLLECTION_MAJOR 3 # define STLSOFT_VER_STLSOFT_ALGORITHMS_HPP_COLLECTION_MINOR 1 # define STLSOFT_VER_STLSOFT_ALGORITHMS_HPP_COLLECTION_REVISION 1 # define STLSOFT_VER_STLSOFT_ALGORITHMS_HPP_COLLECTION_EDIT 69 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ /* ///////////////////////////////////////////////////////////////////////// * Includes */ #ifndef STLSOFT_INCL_STLSOFT_H_STLSOFT # include #endif /* !STLSOFT_INCL_STLSOFT_H_STLSOFT */ #ifndef STLSOFT_INCL_STLSOFT_ALGORITHM_STD_HPP_ALT # include #endif /* !STLSOFT_INCL_STLSOFT_ALGORITHM_STD_HPP_ALT */ /* ///////////////////////////////////////////////////////////////////////// * Namespace */ #ifndef _STLSOFT_NO_NAMESPACE namespace stlsoft { #endif /* _STLSOFT_NO_NAMESPACE */ /* ///////////////////////////////////////////////////////////////////////// * Algorithms */ /** \brief Invokes std::for_each() on the range of items in a container * * \ingroup group__library__algorithms * * \param container The container instance * \param value The value that to assign to each element in the container */ template< ss_typename_param_k C , ss_typename_param_k V > // [[synesis:function:algorithm: fill_all(T &container, T const& value)]] inline void fill_all(C &container, V const& value) { fill(container.begin(), container.end(), value); } #ifdef STLSOFT_CF_STATIC_ARRAY_SIZE_DETERMINATION_SUPPORT /** \brief Invokes std::for_each() on the range of items in an array * * \ingroup group__library__algorithms * * \param ar The array * \param value The value to set to each element in the array */ // [[synesis:function:algorithm: fill_all(T-A ar, T const& value)]] template< ss_typename_param_k T , ss_size_t N , ss_typename_param_k V > inline void fill_all(T (&ar)[N], V const& value) { fill(&ar[0], &ar[N], value); } #endif /* STLSOFT_CF_STATIC_ARRAY_SIZE_DETERMINATION_SUPPORT */ /** \brief Invokes std::for_each() on the range of items in a container * * \ingroup group__library__algorithms * * \param container The container instance * \param func The function to be applied to each element in the container */ template< ss_typename_param_k C , ss_typename_param_k UF > // [[synesis:function:algorithm: for_all(T &container, T func)]] inline UF for_all(C &container, UF func) { return std_for_each(container.begin(), container.end(), func); } #ifdef STLSOFT_CF_STATIC_ARRAY_SIZE_DETERMINATION_SUPPORT /** \brief Invokes std::for_each() on the range of items in an array * * \ingroup group__library__algorithms * * \param ar The array * \param func The function to be applied to each element in the array */ // [[synesis:function:algorithm: for_all(T-A ar, T func)]] template< ss_typename_param_k T , ss_size_t N , ss_typename_param_k UF > inline UF for_all(T (&ar)[N], UF func) { return std_for_each(&ar[0], &ar[N], func); } #endif /* STLSOFT_CF_STATIC_ARRAY_SIZE_DETERMINATION_SUPPORT */ /** \brief Invokes std::for_each() on the reverse range of items in a container * * \ingroup group__library__algorithms * * \param container The container instance * \param func The function to be applied to each element in the container */ // [[synesis:function:algorithm: for_all_r(T &container, T func)]] template< ss_typename_param_k C , ss_typename_param_k UF > inline UF for_all_r(C &container, UF func) { return std_for_each(container.rbegin(), container.rend(), func); } /** \brief Invokes std::copy() on all the items in a container * * \ingroup group__library__algorithms * * \param container The container instance * \param dest The output iterator to which each element will be copied */ // [[synesis:function:algorithm: copy_all(T &container, T dest)]] template< ss_typename_param_k C , ss_typename_param_k O > inline O copy_all(C &container, O dest) { return std_copy(container.begin(), container.end(), dest); } #ifdef STLSOFT_CF_STATIC_ARRAY_SIZE_DETERMINATION_SUPPORT /** \brief Invokes std::copy() on the range of items in an array * * \ingroup group__library__algorithms * * \param ar The array * \param dest The output iterator to which each element will be copied */ template< ss_typename_param_k T , ss_size_t N , ss_typename_param_k O > // [[synesis:function:algorithm: copy_all(T-A ar, T dest)]] inline O copy_all(T (&ar)[N], O dest) { return std_copy(&ar[0], &ar[N], dest); } #endif /* STLSOFT_CF_STATIC_ARRAY_SIZE_DETERMINATION_SUPPORT */ //////////////////////////////////////////////////////////////////////////// // Unit-testing #ifdef STLSOFT_UNITTEST # include "./unittest/collection_unittest_.h" #endif /* STLSOFT_UNITTEST */ /* ////////////////////////////////////////////////////////////////////// */ #ifndef _STLSOFT_NO_NAMESPACE } // namespace stlsoft #endif /* _STLSOFT_NO_NAMESPACE */ /* ////////////////////////////////////////////////////////////////////// */ #endif /* !STLSOFT_INCL_STLSOFT_ALGORITHMS_HPP_COLLECTION */ /* ///////////////////////////// end of file //////////////////////////// */