Namensräume
Varianten
Aktionen

std::exclusive_scan

Von cppreference.com
< cpp‎ | algorithm
 
 
Algorithmenbibliothek
Beschränkte Algorithmen und Algorithmen für Bereiche (C++20)
Beschränkte Algorithmen, z.B. ranges::copy, ranges::sort, ...
Ausführungsrichtlinien (C++17)
Nicht-modifizierende Sequenzoperationen
Stapeloperationen
(C++17)
Suchoperationen
(C++11)                (C++11)(C++11)

Modifizierende Sequenzoperationen
Kopieroperationen
(C++11)
(C++11)
Tauschoperationen
Transformationsoperationen
Generierungsoperationen
Entfernungsoperationen
Ordnungsändernde Operationen
(bis C++17)(C++11)
(C++20)(C++20)
Stichprobenoperationen
(C++17)

Sortier- und verwandte Operationen
Partitionierungsoperationen
Sortieroperationen
Binäre Suchoperationen
(auf partitionierten Bereichen)
Mengenoperationen (auf sortierten Bereichen)
Zusammenführungsoperationen (auf sortierten Bereichen)
Heapoperationen
Minimum/Maximum-Operationen
(C++11)
(C++17)
Lexikographische Vergleichsoperationen
Permutationsoperationen
C-Bibliothek
Numerische Operationen
(C++17)   
exclusive_scan
(C++17)
Operationen auf uninitialisiertem Speicher
 
 
Definiert in der Header-Datei <numeric>
template< class InputIt, class OutputIt, class T >

OutputIt exclusive_scan( InputIt first, InputIt last,

                         OutputIt d_first, T init );
(1) (seit C++17)
(constexpr seit C++20)
template< class ExecutionPolicy,

          class ForwardIt1, class ForwardIt2, class T >
ForwardIt2 exclusive_scan( ExecutionPolicy&& policy,
                           ForwardIt1 first, ForwardIt1 last,

                           ForwardIt2 d_first, T init );
(2) (seit C++17)
template< class InputIt, class OutputIt,

          class T, class BinaryOp >
OutputIt exclusive_scan( InputIt first, InputIt last,

                         OutputIt d_first, T init, BinaryOp op );
(3) (seit C++17)
(constexpr seit C++20)
template< class ExecutionPolicy,

          class ForwardIt1, class ForwardIt2,
          class T, class BinaryOp >
ForwardIt2 exclusive_scan( ExecutionPolicy&& policy,
                           ForwardIt1 first, ForwardIt1 last,

                           ForwardIt2 d_first, T init, BinaryOp op );
(4) (seit C++17)
1) Entspricht exclusive_scan(first, last, d_first, init, std::plus<>().
3) Berechnet die exklusive Präfixsumme mittels op.
Für jede ganze Zahl i in [0std::distance(first, last)), werden nacheinander folgende Operationen ausgeführt:
  1. Erzeugt eine Sequenz, die durch init gefolgt von den Elementen von [firstiter) in Reihenfolge gebildet wird, wobei iter der nächste ite Iterator von first ist.
  2. Berechnet die generalisierte nicht-kommutative Summe der Sequenz über op.
  3. Weist das Ergebnis *dest zu, wobei dest der nächste ite Iterator von d_first ist.
2,4) Dasselbe wie (1,3), aber ausgeführt gemäß policy.
Diese Überladungen nehmen an der Auflösungsauflösung teil, nur wenn alle folgenden Bedingungen erfüllt sind

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> ist true.

(bis C++20)

std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> ist true.

(seit C++20)

Die *verallgemeinerte nicht-kommutative Summe* einer Sequenz von Elementen über eine binäre Operation binary_op ist wie folgt definiert:

  • Wenn die Sequenz nur ein Element enthält, ist die Summe der Wert des Elements.
  • Andernfalls werden die folgenden Operationen der Reihe nach ausgeführt
  1. Wählt zwei beliebige benachbarte Elemente elem1 und elem2 aus der Sequenz aus.
  2. Berechnet binary_op(elem1, elem2) und ersetzt die beiden Elemente in der Sequenz durch das Ergebnis.
  3. Wiederholt die Schritte 1 und 2, bis nur noch ein Element in der Sequenz verbleibt.


Gegeben binary_op als die tatsächliche binäre Operation

  • Das Ergebnis ist nicht deterministisch, wenn die binary_op nicht assoziativ ist (z. B. Gleitkommaaddition).
  • Wenn einer der folgenden Werte nicht in T konvertierbar ist, ist das Programm schlecht geformt
  • binary_op(init, *first)
  • binary_op(init, init)
  • binary_op(*first, *first)
  • Wenn eine der folgenden Bedingungen erfüllt ist, ist das Verhalten undefiniert
  • T ist nicht MoveConstructible.
  • binary_op modifiziert kein Element von [firstlast).
  • binary_op macht keinen Iterator oder Teilbereich von [firstlast] ungültig.

Inhalt

[bearbeiten] Parameter

first, last - das Iteratorenpaar, das den Bereich der zu summierenden Elemente definiert
d_first - der Anfang des Zielbereichs; kann gleich first sein
policy - die Ausführungsrichtlinie, die verwendet werden soll
init - der Anfangswert
op - binäres FunctionObject, das auf das Ergebnis der Dereferenzierung der Eingabeiteratoren, die Ergebnisse anderer op und init angewendet wird
Typanforderungen
-
InputIt muss die Anforderungen von LegacyInputIterator erfüllen.
-
OutputIt muss die Anforderungen an LegacyOutputIterator erfüllen.
-
ForwardIt1, ForwardIt2 müssen die Anforderungen an LegacyForwardIterator erfüllen.

[bearbeiten] Rückgabewert

Iterator auf das Element nach dem letzten geschriebenen Element.

[bearbeiten] Komplexität

Gegeben N als std::distance(first, last)

1,2) O(N) Anwendungen von std::plus<>().
3,4) O(N) Anwendungen von op.

[bearbeiten] Ausnahmen

Die Überladungen mit einem Template-Parameter namens ExecutionPolicy berichten Fehler wie folgt

  • Wenn die Ausführung einer Funktion, die als Teil des Algorithmus aufgerufen wird, eine Ausnahme auslöst und ExecutionPolicy eine der Standardrichtlinien ist, wird std::terminate aufgerufen. Für jede andere ExecutionPolicy ist das Verhalten implementierungsabhängig.
  • Wenn dem Algorithmus der Speicher zur Neuzuweisung fehlt, wird std::bad_alloc ausgelöst.

[bearbeiten] Beispiel

#include <functional>
#include <iostream>
#include <iterator>
#include <numeric>
#include <vector>
 
int main()
{
    std::vector data{3, 1, 4, 1, 5, 9, 2, 6};
 
    std::cout << "Exclusive sum: ";
    std::exclusive_scan(data.begin(), data.end(),
                        std::ostream_iterator<int>(std::cout, " "),
                        0);
 
    std::cout << "\nInclusive sum: ";
    std::inclusive_scan(data.begin(), data.end(),
                        std::ostream_iterator<int>(std::cout, " "));
 
    std::cout << "\n\nExclusive product: ";
    std::exclusive_scan(data.begin(), data.end(),
                        std::ostream_iterator<int>(std::cout, " "),
                        1, std::multiplies<>{});
 
    std::cout << "\nInclusive product: ";
    std::inclusive_scan(data.begin(), data.end(),
                        std::ostream_iterator<int>(std::cout, " "),
                        std::multiplies<>{});
}

Ausgabe

Exclusive sum: 0 3 4 8 9 14 23 25
Inclusive sum: 3 4 8 9 14 23 25 31
 
Exclusive product: 1 3 3 12 12 60 540 1080
Inclusive product: 3 3 12 12 60 540 1080 6480

[bearbeiten] Siehe auch

berechnet die Differenzen zwischen benachbarten Elementen in einer Reihe
(Funktionstemplate) [bearbeiten]
summiert oder faltet eine Reihe von Elementen
(Funktionstemplate) [bearbeiten]
berechnet die partielle Summe einer Elementreihe
(Funktionstemplate) [bearbeiten]
wendet eine aufrufbare Funktion an und berechnet dann einen exklusiven Scan
(Funktionstemplate) [bearbeiten]
ähnlich wie std::partial_sum, schließt das i-te Eingabeelement in die i-te Summe ein
(Funktionstemplate) [bearbeiten]