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

fix(weave): optimize finding next tick up or down #3231

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
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
68 changes: 68 additions & 0 deletions weave-js/src/common/components/elements/SliderInput.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
import {getClosestTick} from './SliderInput';

describe('getClosestTick', () => {
test('lower previous value returns next greater', () => {
const ticks = [2, 4, 6, 8, 10];
const previous = 4;
const val = 5;
expect(getClosestTick(ticks, val, previous)).toBe(6);
});
test('lower previous value returns next greater, large step', () => {
const ticks = [2, 4, 60, 80, 10];
const previous = 4;
const val = 5;
expect(getClosestTick(ticks, val, previous)).toBe(60);
});
test('greater previous value returns next lesser', () => {
const ticks = [2, 4, 6, 8, 10];
const previous = 4;
const val = 3;
const actual = getClosestTick(ticks, val, previous);
expect(actual).toBe(2);
});
test('greater previous value returns next lesser, consecutive', () => {
const ticks = [1, 2, 3, 4, 5, 6];
const previous = 4;
const val = 3;
const actual = getClosestTick(ticks, val, previous);
expect(actual).toBe(3);
});
test('lower previous value returns next greater, consecutive', () => {
const ticks = [1, 2, 3, 4, 5, 6];
const previous = 3;
const val = 4;
const actual = getClosestTick(ticks, val, previous);
expect(actual).toBe(4);
});
test('lower previous value returns next greater, erratic', () => {
const ticks = [1, 4, 5, 7, 9, 12];
const previous = 9;
const val = 10;
const actual = getClosestTick(ticks, val, previous);
expect(actual).toBe(12);
});
test('greater previous value returns next lower, erratic', () => {
const ticks = [1, 2, 5, 7, 9, 12];
const previous = 5;
const val = 4;
const actual = getClosestTick(ticks, val, previous);
expect(actual).toBe(2);
});

// Modified logic, retaining for expected performance
test('large number of ticks', () => {
const ticks = [];
for (let i = 0; i < 10000000; i += 2) {
ticks.push(i);
}

const previous = 500000;
const val = 500001;
const start = Date.now();
const actual = getClosestTick(ticks, val, previous);
const end = Date.now();
const duration = end - start;
expect(actual).toBe(500002);
expect(duration).toBeLessThanOrEqual(1);

Choose a reason for hiding this comment

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

these tests are awesome! could you add one for testing the bounds as well? like one where the val is less than the smallest tick and also one where the val is larger than the largest tick?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh I like it, sure. That logic lives in the update() function that calls getClosestTick() when it has a list of ticks. I might suck that logic into this function instead, and leave update() as a, "get the right value and synchronize the inputs fields."

});
});
37 changes: 29 additions & 8 deletions weave-js/src/common/components/elements/SliderInput.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,12 @@ const SliderInput: React.FC<SliderInputProps> = React.memo(
newVal = min;
}
if (ticks != null) {
newVal = getClosestTick(ticks, newVal);
newVal = getClosestTick(ticks, newVal, sliderValue);
}
setSliderValue(newVal);
onChangeDebounced(newVal);
},
[ticks, min, max, allowGreaterThanMax, onChangeDebounced]
[ticks, min, max, allowGreaterThanMax, sliderValue, onChangeDebounced]
);

React.useEffect(() => {
Expand Down Expand Up @@ -172,17 +172,38 @@ const SliderInput: React.FC<SliderInputProps> = React.memo(

export default SliderInput;

function getClosestTick(ticks: number[], val: number): number {
export function getClosestTick(
ticks: number[],
val: number,
prev: number
): number {
let closest = val;
const increasing = val > prev;
let minDiff = Number.MAX_VALUE;

for (const tick of ticks) {
// Binary search for the closest tick
let left = 0;
let right = ticks.length - 1;

while (left <= right) {
const mid = Math.floor((left + right) / 2);
const tick = ticks[mid];
const diff = Math.abs(tick - val);
if (diff >= minDiff) {
break;

// Only update closest if the tick is in the right direction
if (
diff < minDiff &&
((increasing && tick >= val) || (!increasing && tick <= val))
) {
closest = tick;

Choose a reason for hiding this comment

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

could we have something to break out early if tick is equal to val?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, lets not go searching through half the list if the slider increments to a valid step, heh. Good call.

minDiff = diff;
}

if (tick < val) {
left = mid + 1;
} else {
right = mid - 1;
}
closest = tick;
minDiff = diff;
}

return closest;
Expand Down
Loading