apache / datasketches-java / #94

Build # #94

Build Type

push

Committed by

Commit Message

<a href="https://github.com/apache/datasketches-java/commit/<a class=hub.com/apache/datasketches-java/commit/5a5b849c72f220449b0413ae15d0882007ddfad0">5a5b849c7<a href="https://github.com/apache/datasketches-java/commit/5a5b849c72f220449b0413ae15d0882007ddfad0">">Merge </a><a class="double-link" href="https://github.com/apache/datasketches-java/commit/<a class="double-link" href="https://github.com/apache/datasketches-java/commit/c07e970029c354f7ee33d090b2c02475f24c8758">c07e97002</a>">c07e97002</a><a href="https://github.com/apache/datasketches-java/commit/5a5b849c72f220449b0413ae15d0882007ddfad0"> into 8044759d8">8044759d8</a>

Run Details

81 of 81 new or added lines in 3 files covered. (100.0%)

17483 of 17701 relevant lines covered (98.77%)

0.99 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

75.0

/src/main/java/org/apache/datasketches/theta/PairwiseSetOperations.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.datasketches.theta;

import static org.apache.datasketches.Util.DEFAULT_NOMINAL_ENTRIES;

/**
 * Set Operations where the arguments are presented in pairs as in <i>C = Op(A,B)</i>. These are
 * stateless operations and the result is returned immediately.
 *
 * <p>These operations are designed for convenience and accept Sketches that may be either
 * Heap-based or Direct.
 *
 * @author Lee Rhodes
 * @deprecated v2.0.0. This class has been deprecated as equivalent functionality has been added to the
 * SetOperation classes: {@link Union}, {@link Intersection} and {@link AnotB}.
 */
@Deprecated
public class PairwiseSetOperations {

  /**
   * This implements a stateless, pair-wise <i>Intersect</i> operation on sketches
   * that are either Heap-based or Direct.
   * If either inputs are null or empty an EmptyCompactSketch is returned.
   *
   * @param skA The first Sketch argument.
   * @param skB The second Sketch argument.
   * @return the result as an ordered CompactSketch on the heap.
   * @deprecated v2.0.0. Use {@link Intersection#intersect(Sketch, Sketch)} instead, which has more
   * complete seed handling.
   */
  @Deprecated
  public static CompactSketch intersect(final Sketch skA, final Sketch skB) {
    final Intersection inter = new SetOperationBuilder().buildIntersection();
    return inter.intersect(skA, skB);
  }

  /**
   * This implements a stateless, pair-wise <i>A AND NOT B</i> operation on Sketches
   * that are either Heap-based or Direct.
   * If both inputs are null an EmptyCompactSketch is returned.
   *
   * @param skA The first Sketch argument.
   * @param skB The second Sketch argument.
   * @return the result as an ordered CompactSketch on the heap.
   * @deprecated v2.0.0. Use {@link AnotB#aNotB(Sketch, Sketch)} instead, which has more
   * complete seed handling.
   */
  @Deprecated
  public static CompactSketch aNotB(final Sketch skA, final Sketch skB) {
    final AnotB anotb = new SetOperationBuilder().buildANotB();
    return anotb.aNotB(skA, skB);
  }

  /**
   * This implements a stateless, pair-wise union operation on ordered,
   * CompactSketches that are either Heap-based or Direct.
   * Having the input sketches be compact and ordered enables extremely fast union operation.
   * If both inputs are null an EmptyCompactSketch is returned.
   * If one is null the other is returned, which can be either Heap-based or Direct.
   * This is equivalent to union(skA, skB, k) where k is the default of 4096.
   *
   * @param skA The first ordered, CompactSketch argument.
   * @param skB The second ordered, CompactSketch argument
   * @return the result as an ordered CompactSketch.
   * @deprecated v2.0.0. Please use {@link Union#union(Sketch, Sketch)} instead, which has more
   * complete seed handling.
   */
  @Deprecated
  public static CompactSketch union(final CompactSketch skA, final CompactSketch skB) {
    return union(skA, skB, DEFAULT_NOMINAL_ENTRIES);
  }

  /**
   * This implements a stateless, pair-wise union operation on ordered,
   * CompactSketches that are either Heap-based or Direct. The returned sketch will be cutback to
   * k if required, similar to the regular Union operation. If a cutback is required, the returned
   * sketch will always be on the heap.
   * If both inputs are null a null is returned. If either sketch is empty its Theta is ignored.
   * If one is null the other is returned, which may be either Direct or heap-based if a cutback
   * is required.
   *
   * @param skA The first ordered, CompactSketch argument.
   * @param skB The second ordered, CompactSketch argument
   * @param k The upper bound of the number of entries to be retained by the sketch
   * @return the result as an ordered CompactSketch.
   * @deprecated v2.0.0. Please use {@link Union#union(Sketch, Sketch)} instead, which has more
   * complete seed handling.
   */
  @Deprecated
  public static CompactSketch union(final CompactSketch skA, final CompactSketch skB, final int k) {
    final Union un = new SetOperationBuilder().setNominalEntries(k).buildUnion();
    return un.union(skA, skB);
  }

}

1	/*
2	* Licensed to the Apache Software Foundation (ASF) under one
3	* or more contributor license agreements. See the NOTICE file
4	* distributed with this work for additional information
5	* regarding copyright ownership. The ASF licenses this file
6	* to you under the Apache License, Version 2.0 (the
7	* "License"); you may not use this file except in compliance
8	* with the License. You may obtain a copy of the License at
9	*
10	* http://www.apache.org/licenses/LICENSE-2.0
11	*
12	* Unless required by applicable law or agreed to in writing,
13	* software distributed under the License is distributed on an
14	* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15	* KIND, either express or implied. See the License for the
16	* specific language governing permissions and limitations
17	* under the License.
18	*/
19
20	package org.apache.datasketches.theta;
21
22	import static org.apache.datasketches.Util.DEFAULT_NOMINAL_ENTRIES;
23
24	/**
25	* Set Operations where the arguments are presented in pairs as in <i>C = Op(A,B)</i>. These are
26	* stateless operations and the result is returned immediately.
27	*
28	* <p>These operations are designed for convenience and accept Sketches that may be either
29	* Heap-based or Direct.
30	*
31	* @author Lee Rhodes
32	* @deprecated v2.0.0. This class has been deprecated as equivalent functionality has been added to the
33	* SetOperation classes: {@link Union}, {@link Intersection} and {@link AnotB}.
34	*/
35	@Deprecated
36	public class PairwiseSetOperations {	×
37
38	/**
39	* This implements a stateless, pair-wise <i>Intersect</i> operation on sketches
40	* that are either Heap-based or Direct.
41	* If either inputs are null or empty an EmptyCompactSketch is returned.
42	*
43	* @param skA The first Sketch argument.
44	* @param skB The second Sketch argument.
45	* @return the result as an ordered CompactSketch on the heap.
46	* @deprecated v2.0.0. Use {@link Intersection#intersect(Sketch, Sketch)} instead, which has more
47	* complete seed handling.
48	*/
49	@Deprecated
50	public static CompactSketch intersect(final Sketch skA, final Sketch skB) {
51	final Intersection inter = new SetOperationBuilder().buildIntersection();	1✔
52	return inter.intersect(skA, skB);	1✔
53	}
54
55	/**
56	* This implements a stateless, pair-wise <i>A AND NOT B</i> operation on Sketches
57	* that are either Heap-based or Direct.
58	* If both inputs are null an EmptyCompactSketch is returned.
59	*
60	* @param skA The first Sketch argument.
61	* @param skB The second Sketch argument.
62	* @return the result as an ordered CompactSketch on the heap.
63	* @deprecated v2.0.0. Use {@link AnotB#aNotB(Sketch, Sketch)} instead, which has more
64	* complete seed handling.
65	*/
66	@Deprecated
67	public static CompactSketch aNotB(final Sketch skA, final Sketch skB) {
68	final AnotB anotb = new SetOperationBuilder().buildANotB();	1✔
69	return anotb.aNotB(skA, skB);	1✔
70	}
71
72	/**
73	* This implements a stateless, pair-wise union operation on ordered,
74	* CompactSketches that are either Heap-based or Direct.
75	* Having the input sketches be compact and ordered enables extremely fast union operation.
76	* If both inputs are null an EmptyCompactSketch is returned.
77	* If one is null the other is returned, which can be either Heap-based or Direct.
78	* This is equivalent to union(skA, skB, k) where k is the default of 4096.
79	*
80	* @param skA The first ordered, CompactSketch argument.
81	* @param skB The second ordered, CompactSketch argument
82	* @return the result as an ordered CompactSketch.
83	* @deprecated v2.0.0. Please use {@link Union#union(Sketch, Sketch)} instead, which has more
84	* complete seed handling.
85	*/
86	@Deprecated
87	public static CompactSketch union(final CompactSketch skA, final CompactSketch skB) {
88	return union(skA, skB, DEFAULT_NOMINAL_ENTRIES);	×
89	}
90
91	/**
92	* This implements a stateless, pair-wise union operation on ordered,
93	* CompactSketches that are either Heap-based or Direct. The returned sketch will be cutback to
94	* k if required, similar to the regular Union operation. If a cutback is required, the returned
95	* sketch will always be on the heap.
96	* If both inputs are null a null is returned. If either sketch is empty its Theta is ignored.
97	* If one is null the other is returned, which may be either Direct or heap-based if a cutback
98	* is required.
99	*
100	* @param skA The first ordered, CompactSketch argument.
101	* @param skB The second ordered, CompactSketch argument
102	* @param k The upper bound of the number of entries to be retained by the sketch
103	* @return the result as an ordered CompactSketch.
104	* @deprecated v2.0.0. Please use {@link Union#union(Sketch, Sketch)} instead, which has more
105	* complete seed handling.
106	*/
107	@Deprecated
108	public static CompactSketch union(final CompactSketch skA, final CompactSketch skB, final int k) {
109	final Union un = new SetOperationBuilder().setNominalEntries(k).buildUnion();	1✔
110	return un.union(skA, skB);	1✔
111	}
112
113	}

apache / datasketches-java / #94

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous