org.apache.lucene.queries.function.valuesource.ConstKnnFloatValueSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lucene-queries Show documentation

Lucene Queries Module

There is a newer version: 10.0.0

/*
 * 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.queries.function.valuesource;

import java.io.IOException;
import java.util.Arrays;
import java.util.Map;
import java.util.Objects;
import org.apache.lucene.index.LeafReaderContext;
import org.apache.lucene.queries.function.FunctionValues;
import org.apache.lucene.queries.function.ValueSource;
import org.apache.lucene.util.VectorUtil;

/** Function that returns a constant float vector value for every document. */
public class ConstKnnFloatValueSource extends ValueSource {
  private final float[] vector;

  public ConstKnnFloatValueSource(float[] constVector) {
    this.vector = VectorUtil.checkFinite(Objects.requireNonNull(constVector, "constVector"));
  }

  @Override
  public FunctionValues getValues(Map context, LeafReaderContext readerContext)
      throws IOException {
    return new FunctionValues() {
      @Override
      public float[] floatVectorVal(int doc) {
        return vector;
      }

      @Override
      public String strVal(int doc) {
        return Arrays.toString(vector);
      }

      @Override
      public String toString(int doc) throws IOException {
        return description() + '=' + strVal(doc);
      }
    };
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    ConstKnnFloatValueSource other = (ConstKnnFloatValueSource) o;
    return Arrays.equals(vector, other.vector);
  }

  @Override
  public int hashCode() {
    return Objects.hash(getClass().hashCode(), Arrays.hashCode(vector));
  }

  @Override
  public String description() {
    return "ConstKnnFloatValueSource(" + Arrays.toString(vector) + ')';
  }
}