Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed bug in _.sortedIndex that put undefined at the start (FIX: #1834) #2042

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions test/arrays.js
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,33 @@
equal(_.sortedIndex(array, 2147483648), 2147483648, 'should work with large indexes');
});

test('sortedIndex conforms to sortBy for undefined (#1834)', function() {
var sorted = _.sortBy([undefined, 1, undefined, 2]);
equal(_.sortedIndex(sorted, undefined, _.identity), 2);

var edgeCaseNumbers = [-Infinity, -Infinity, 0, 345345345234, Infinity, Infinity, undefined, undefined, NaN];
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thats slightly off of what _.sortBy would produce

[-Infinity, -Infinity, 0, 345345345234, Infinity, Infinity, NaN, undefined, undefined];

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With that fix my suggestion passes megawac@45e7a4c

Feel free to cherry-pick that commit on to this branch

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Naw NaN should be after undefined. There's a PR open for it. See #1768 (comment).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it matters what order they go in, the most important thing is _.sortBy and _.sortedIndex are consistent with one another for the values

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've been through this before. The comment I linked to is your own comment (updated).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I know thats how I handled it in my implementation, but I don't think theres a particularly good argument for placing them one way or another, just that they should be consistently handled the same between the two methods, unless you have one.

Anyway, doing that would require changes to _.sortBy handling of the two values for likely minimal gain

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_.sortBy would still need to be modified to handle the values consistently:

_.sortBy([1, 2, NaN, {}, NaN, undefined]);
// => [1, 2, NaN, {}, NaN, undefined]

and to add to that there's consistency with lodash which sorts NaN at the end as per our earlier discussions.


var indexForUndefined = _.sortedIndex(edgeCaseNumbers, undefined);
equal(indexForUndefined, 6, 'undefined should be inserted at index 6');

var indexForNegInfinity = _.sortedIndex(edgeCaseNumbers, -Infinity);
equal(indexForNegInfinity, 0, 'negative infinity should be inserted at index 0');

var indexForInfinity = _.sortedIndex(edgeCaseNumbers, Infinity);
equal(indexForInfinity, 4, 'infinity should be inserted at index 4');

var indexForZero = _.sortedIndex(edgeCaseNumbers, 0);
equal(indexForZero, 2, '0 should be inserted at index 2');

var indexForNaN = _.sortedIndex(edgeCaseNumbers, NaN);
equal(indexForNaN, 8, 'NaN should be inserted at index 8');

var numbers = [10, 20, 30, 40, 50];

var indexForUndefinedSimple = _.sortedIndex(numbers, undefined);
equal(indexForUndefinedSimple, 5, 'undefined should be inserted at index 5');
});

test('uniq', function() {
var list = [1, 2, 1, 3, 1, 4];
deepEqual(_.uniq(list), [1, 2, 3, 4], 'can find the unique values of an unsorted array');
Expand Down
3 changes: 2 additions & 1 deletion underscore.js
Original file line number Diff line number Diff line change
Expand Up @@ -685,7 +685,8 @@
var low = 0, high = array.length;
while (low < high) {
var mid = Math.floor((low + high) / 2);
if (iteratee(array[mid]) < value) low = mid + 1; else high = mid;
var cur = iteratee(array[mid]);
if ( cur < value || (value === void 0 && cur <= Infinity) || (_.isNaN(value) && (cur <= Infinity || cur === void 0))) low = mid + 1; else high = mid;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've been pretty busy the past couple weeks (exam time) but I'm playing with this logic now. I've almost got it passing (1 failing test) with this

if ( cur < value || (cur <= Infinity && !(value <= value)) ) low = mid + 1;
else high = mid;

}
return low;
};
Expand Down