benwtrent commented on code in PR #13651: URL: https://github.com/apache/lucene/pull/13651#discussion_r1742505038
########## lucene/core/src/java/org/apache/lucene/codecs/lucene912/BinarizedByteVectorValues.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.codecs.lucene912; + +import java.io.IOException; +import org.apache.lucene.index.ByteVectorValues; +import org.apache.lucene.search.DocIdSetIterator; +import org.apache.lucene.search.VectorScorer; + +/** + * A version of {@link ByteVectorValues}, but additionally retrieving score correction values offset + * for binarization quantization scores. + * + * @lucene.experimental + */ +public abstract class BinarizedByteVectorValues extends DocIdSetIterator { + public abstract float getDistanceToCentroid() throws IOException; + + /** Returns the cluster ID for the vector in the range [0, 255] */ + public abstract short clusterId() throws IOException; + + public static byte encodeClusterIdToByte(short clusterId) { + byte bClusterId = clusterId <= 127 ? (byte) clusterId : (byte) (clusterId - 256); + return bClusterId; + } + + public static short decodeClusterIdFromByte(byte bClusterId) { + short clusterId = bClusterId >= 0 ? (short) bClusterId : (short) (bClusterId + 256); + return clusterId; + } + + public abstract float getMagnitude() throws IOException; + + public abstract float getOOQ() throws IOException; + + public abstract float getNormOC() throws IOException; + + public abstract float getODotC() throws IOException; Review Comment: I would really like if we just did `float[]` and the callers (which are scorers) know how to use it. The downside now is that if something calls `getODotC()` but it wasn't available, this would blow up right? @john-wagster -- 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-unsubscr...@lucene.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
