Documentation

Sorts the events using the specified event function. The function must return a real value or must be convertable to a real value.

Example:

    // Pick the 20 events with largest amplitude and put
    // them in descending order into s2.
    Set s1 ("input.xml");
    Set s2;
    Sort (s1.Begin(), s1.End(), back_inserter (s2),
          Column("Amplitude"), false, 20);
    

Returns:

End iterator of stored events

Parameters:

sourceBegin - Start iterator of event list
sourceEnd - End iterator of event list
dest - Output iterator to store sorted events
func - Event function (Sort order)
ascending - Sort order (true default)
n - Maximum number of sorted events (0 = all)