VectorTools.icc

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file VectorTools.icc
 * @author Tero Ryynänen (tero.ryynanen-no.spam-tut.fi) 2008
 *
 * Tools for handling STL Iterative Containers (usually vector).
 *
 * Inline and template definitions.
 *
 */
 
/**
 * Returns true if given container contains the given value.
 *
 * @param aVec The vector to look in.
 * @param aValue Value to compare to.
 *
 * @return Returns true if value was found, false otherwise.
 */
template <typename ContainerType, typename ValueType>
bool
VectorTools::containsValue(const ContainerType& aVec, const ValueType& aValue) {
    for (typename ContainerType::const_iterator i = aVec.begin();
         i != aVec.end(); i++) {
        if (*i == aValue)
            return true;
    }
    return false;
}
 
/**
 * Inserts value to container if it doesn't already include it.
 *
 * @param aVec The vector to which value is inserted.
 * @param aValue Value to insert.
 * 
 * @return Returns true if value was inserted, false otherwise.
 */
template <typename ContainerType, typename ValueType>
bool
VectorTools::insertUnique(ContainerType& aVec, const ValueType& aValue) {
    if (VectorTools::containsValue<ContainerType, ValueType>(aVec, aValue)) {
        return false;
    } else {
        aVec.push_back(aValue);
        return true;
    }
}
 
 
/**
 * Sorts container and removes duplicate entries from it.
 *
 * @param aVec The vector to be operated.
 * 
 */
template <typename ContainerType, typename ValueType>
void
VectorTools::removeDuplicates(ContainerType& aVec, const ValueType&) {
    std::sort(aVec.begin(), aVec.end());
    aVec.erase(std::unique(aVec.begin(), aVec.end()), aVec.end());
}