luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-05-08 23:13:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

GSequence: add note about lookup requiring sorting

Browse Source 
g_sequence_lookup() only works on sorted sequences, but it's quite easy
to create unsorted sequences.  Add a note to the documentation that the
sequence must be sorted in order for g_sequence_lookup() to work.

https://bugzilla.gnome.org/show_bug.cgi?id=670969
This commit is contained in:
Jörn Magens 2012-02-29 12:29:50 -05:00 committed by Ryan Lortie
parent 7e7e0b141c
commit 00f1e1f5c2
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
glib/gsequence.c
View File

@ -770,6 +770,14 @@ g_sequence_sort_changed (GSequenceIter *iter,
* If you are simply searching for an existing element of the sequence, * If you are simply searching for an existing element of the sequence,
* consider using g_sequence_lookup(). * consider using g_sequence_lookup().
* *
* <note><para>
* This function will fail if the data contained in the sequence is
* unsorted. Use g_sequence_insert_sorted() or
* g_sequence_insert_sorted_iter() to add data to your sequence or, if
* you want to add a large amount of data, call g_sequence_sort() after
* doing unsorted insertions.
* </para></note>
*
* Return value: an #GSequenceIter pointing to the position where @data * Return value: an #GSequenceIter pointing to the position where @data
* would have been inserted according to @cmp_func and @cmp_data. * would have been inserted according to @cmp_func and @cmp_data.
* *
@ -811,6 +819,14 @@ g_sequence_search (GSequence *seq,
* the first item comes before the second, and a positive value if * the first item comes before the second, and a positive value if
* the second item comes before the first. * the second item comes before the first.
* *
* <note><para>
* This function will fail if the data contained in the sequence is
* unsorted. Use g_sequence_insert_sorted() or
* g_sequence_insert_sorted_iter() to add data to your sequence or, if
* you want to add a large amount of data, call g_sequence_sort() after
* doing unsorted insertions.
* </para></note>
*
* Return value: an #GSequenceIter pointing to the position of the * Return value: an #GSequenceIter pointing to the position of the
* first item found equal to @data according to @cmp_func and @cmp_data. * first item found equal to @data according to @cmp_func and @cmp_data.
* *
@ -1036,6 +1052,14 @@ g_sequence_insert_sorted_iter (GSequence *seq,
* If you are simply searching for an existing element of the sequence, * If you are simply searching for an existing element of the sequence,
* consider using g_sequence_lookup_iter(). * consider using g_sequence_lookup_iter().
* *
* <note><para>
* This function will fail if the data contained in the sequence is
* unsorted. Use g_sequence_insert_sorted() or
* g_sequence_insert_sorted_iter() to add data to your sequence or, if
* you want to add a large amount of data, call g_sequence_sort() after
* doing unsorted insertions.
* </para></note>
*
* Return value: a #GSequenceIter pointing to the position in @seq * Return value: a #GSequenceIter pointing to the position in @seq
* where @data would have been inserted according to @iter_cmp * where @data would have been inserted according to @iter_cmp
* and @cmp_data. * and @cmp_data.
@ -1088,6 +1112,14 @@ g_sequence_search_iter (GSequence *seq,
* if the first iterator comes before the second, and a positive * if the first iterator comes before the second, and a positive
* value if the second iterator comes before the first. * value if the second iterator comes before the first.
* *
* <note><para>
* This function will fail if the data contained in the sequence is
* unsorted. Use g_sequence_insert_sorted() or
* g_sequence_insert_sorted_iter() to add data to your sequence or, if
* you want to add a large amount of data, call g_sequence_sort() after
* doing unsorted insertions.
* </para></note>
*
* Return value: an #GSequenceIter pointing to the position of * Return value: an #GSequenceIter pointing to the position of
* the first item found equal to @data according to @cmp_func * the first item found equal to @data according to @cmp_func
* and @cmp_data. * and @cmp_data.