You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by GitBox <gi...@apache.org> on 2022/06/20 00:31:00 UTC
[GitHub] [lucene] mdmarshmallow commented on a diff in pull request #841: LUCENE-10274: Add hyperrectangle faceting capabilities
mdmarshmallow commented on code in PR #841:
URL: https://github.com/apache/lucene/pull/841#discussion_r901174337
##########
lucene/facet/src/java/org/apache/lucene/facet/facetset/FacetSetsField.java:
##########
@@ -0,0 +1,78 @@
+/*
+ * 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.lucene.facet.facetset;
+
+import org.apache.lucene.document.BinaryDocValuesField;
+import org.apache.lucene.document.IntPoint;
+import org.apache.lucene.util.BytesRef;
+
+/**
+ * A {@link BinaryDocValuesField} which encodes a list of {@link FacetSet facet sets}. The encoding
+ * scheme consists of a packed {@code byte[]} where the first value denotes the number of dimensions
+ * in all the sets, followed by each set's values.
+ *
+ * @lucene.experimental
+ */
+public class FacetSetsField extends BinaryDocValuesField {
+
+ /**
+ * Create a new FacetSets field.
+ *
+ * @param name field name
+ * @param facetSets the {@link FacetSet facet sets} to index in that field. All must have the same
+ * number of dimensions
+ * @throws IllegalArgumentException if the field name is null or the given facet sets are invalid
+ */
+ public static FacetSetsField create(String name, FacetSet... facetSets) {
+ if (facetSets == null || facetSets.length == 0) {
+ throw new IllegalArgumentException("FacetSets cannot be null or empty!");
+ }
+
+ return new FacetSetsField(name, toPackedValues(facetSets));
+ }
+
+ private FacetSetsField(String name, BytesRef value) {
+ super(name, value);
+ }
+
+ private static BytesRef toPackedValues(FacetSet... facetSets) {
+ int numDims = facetSets[0].dims;
+ Class<?> expectedClass = facetSets[0].getClass();
+ byte[] buf = new byte[Integer.BYTES + facetSets[0].sizePackedBytes() * facetSets.length];
+ IntPoint.encodeDimension(numDims, buf, 0);
+ int offset = Integer.BYTES;
+ for (FacetSet facetSet : facetSets) {
+ if (facetSet.dims != numDims) {
+ throw new IllegalArgumentException(
+ "All FacetSets must have the same number of dimensions. Expected "
+ + numDims
+ + " found "
+ + facetSet.dims);
+ }
+ // It doesn't make sense to index facet sets of different types in the same field
+ if (facetSet.getClass() != expectedClass) {
Review Comment:
Thoughts on using generics here to enforce this at compile time?
##########
lucene/facet/src/java/org/apache/lucene/facet/facetset/package-info.java:
##########
@@ -0,0 +1,19 @@
+/*
+ * 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.
+ */
+
+/** Provides FacetSets faceting capabilities. */
Review Comment:
Maybe make this slightly more descriptive? "Provides FacetSets faceting capabilities which allows users to facet on on high dimensional field values. See FacetSets.adoc in the docs package for more information on usage." Or something like that.
##########
lucene/facet/src/java/org/apache/lucene/facet/facetset/RangeFacetSetMatcher.java:
##########
@@ -0,0 +1,166 @@
+/*
+ * 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.lucene.facet.facetset;
+
+import java.util.Arrays;
+import org.apache.lucene.util.NumericUtils;
+
+/**
+ * A {@link FacetSetMatcher} which considers a set as a match if all dimensions fall within the
+ * given corresponding range.
+ *
+ * @lucene.experimental
+ */
+public class RangeFacetSetMatcher extends FacetSetMatcher {
+
+ private final long[] lowerRanges;
+ private final long[] upperRanges;
+
+ /**
+ * Constructs an instance to match facet sets with dimensions that fall within the given ranges.
+ */
+ public RangeFacetSetMatcher(String label, DimRange... dimRanges) {
+ super(label, getDims(dimRanges));
+ this.lowerRanges = Arrays.stream(dimRanges).mapToLong(range -> range.min).toArray();
+ this.upperRanges = Arrays.stream(dimRanges).mapToLong(range -> range.max).toArray();
+ }
+
+ @Override
+ public boolean matches(long[] dimValues) {
+ assert dimValues.length == dims
+ : "Encoded dimensions (dims="
+ + dimValues.length
+ + ") is incompatible with range dimensions (dims="
+ + dims
+ + ")";
+
+ for (int i = 0; i < dimValues.length; i++) {
+ if (dimValues[i] < lowerRanges[i]) {
+ // Doc's value is too low in this dimension
+ return false;
+ }
+ if (dimValues[i] > upperRanges[i]) {
+ // Doc's value is too high in this dimension
+ return false;
+ }
+ }
+ return true;
+ }
+
+ private static int getDims(DimRange... dimRanges) {
+ if (dimRanges == null || dimRanges.length == 0) {
+ throw new IllegalArgumentException("dimRanges cannot be null or empty");
+ }
+ return dimRanges.length;
+ }
+
+ /**
+ * Creates a {@link DimRange} for the given min and max long values. This method is also suitable
+ * for int values.
+ */
+ public static DimRange fromLongs(long min, boolean minInclusive, long max, boolean maxInclusive) {
Review Comment:
nit: Should these `from` functions go into the `DimRange` class itself? I think that it makes more sense that way to me personally.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org