filtered_iterator.h | Explore in Territory

// Copyright 2024 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of the copyright holder nor the names of its
//    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 HOLDER 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.

#ifndef SRC_TINT_UTILS_CONTAINERS_FILTERED_ITERATOR_H_
#define SRC_TINT_UTILS_CONTAINERS_FILTERED_ITERATOR_H_

#include <utility>

namespace tint {

/// FilteredIterator is an iterator that skip over elements where the predicate function returns
/// false.
/// @tparam PREDICATE the filter predicate function
/// @tparam ITERATOR the inner iterator type
template <typename PREDICATE, typename ITERATOR>
class FilteredIterator { … };

/// FilteredIterable is a wrapper around an object with begin() / end() methods, that returns
/// iterators that skip over elements where the predicate function returns false.
/// @tparam PREDICATE the filter predicate function
/// @tparam ITERABLE the inner iterable object type
template <typename PREDICATE, typename ITERABLE>
struct FilteredIterable { … };

/// @returns a FilteredIterable from the filter function `PREDICATE`, wrapping @p iterable
/// @tparam PREDICATE the filter predicate function
/// @tparam ITERABLE the inner iterable object type
template <typename PREDICATE, typename ITERABLE>
FilteredIterable<PREDICATE, ITERABLE&> Filter(ITERABLE& iterable) { … }

}  // namespace tint

#endif  // SRC_TINT_UTILS_CONTAINERS_FILTERED_ITERATOR_H_
chromium/third_party/dawn/src/tint/utils/containers/filtered_iterator.h
