File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\jenkins\model\lazy\Boundary.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2012, CloudBees, Inc.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package jenkins.model.lazy;
25
26 /**
27 * ceil/floor/lower/higher implementations
28 * that takes the return value of a binary search as an input.
29 *
30 * <p>
31 * Consider a sorted array of int X={x<sub>i</sub>} and a binary search of p on it.
32 * this class provides likes of {@code ceil(X,p)} which is the smallest x<sub>i</sub>
33 * that still satisfies x<sub>i</sub> >= p.
34 *
35 * Simiarly, {@link #HIGHER} is the smallest x<sub>i</sub>
36 * that still satisfies x<sub>i</sub> > p.
37 *
38 * @author Kohsuke Kawaguchi
39 */
40 enum Boundary {
41 LOWER(-1,-1),
42 HIGHER(1,0),
43 FLOOR(0,-1),
44 CEIL(0,0);
45
46 private final int offsetOfExactMatch, offsetOfInsertionPoint;
47
48 private Boundary(int offsetOfExactMatch, int offsetOfInsertionPoint) {
49 this.offsetOfExactMatch = offsetOfExactMatch;
50 this.offsetOfInsertionPoint = offsetOfInsertionPoint;
51 }
52
53 /**
54 * Computes the boundary value.
55 */
56 public int apply(int binarySearchOutput) {
57 int r = binarySearchOutput;
58 if (r>=0) return r+offsetOfExactMatch; // if we had some x_i==p
59
60 int ip = -(r+1);
61 return ip+offsetOfInsertionPoint;
62 }
63 }
64