org.elasticsearch.common.lucene.search.function.CombineFunction Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.common.lucene.search.function;
import org.apache.lucene.search.Explanation;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.io.stream.Writeable;
import java.io.IOException;
import java.util.Locale;
public enum CombineFunction implements Writeable {
MULTIPLY {
@Override
public float combine(double queryScore, double funcScore, double maxBoost) {
return (float) (queryScore * Math.min(funcScore, maxBoost));
}
@Override
public Explanation explain(Explanation queryExpl, Explanation funcExpl, float maxBoost) {
Explanation boostExpl = Explanation.match(maxBoost, "maxBoost");
Explanation minExpl = Explanation.match(Math.min(funcExpl.getValue().floatValue(), maxBoost), "min of:", funcExpl, boostExpl);
return Explanation.match(
queryExpl.getValue().floatValue() * minExpl.getValue().floatValue(),
"function score, product of:",
queryExpl,
minExpl
);
}
},
REPLACE {
@Override
public float combine(double queryScore, double funcScore, double maxBoost) {
return (float) (Math.min(funcScore, maxBoost));
}
@Override
public Explanation explain(Explanation queryExpl, Explanation funcExpl, float maxBoost) {
Explanation boostExpl = Explanation.match(maxBoost, "maxBoost");
return Explanation.match(Math.min(funcExpl.getValue().floatValue(), maxBoost), "min of:", funcExpl, boostExpl);
}
},
SUM {
@Override
public float combine(double queryScore, double funcScore, double maxBoost) {
return (float) (queryScore + Math.min(funcScore, maxBoost));
}
@Override
public Explanation explain(Explanation queryExpl, Explanation funcExpl, float maxBoost) {
Explanation minExpl = Explanation.match(
Math.min(funcExpl.getValue().floatValue(), maxBoost),
"min of:",
funcExpl,
Explanation.match(maxBoost, "maxBoost")
);
return Explanation.match(
Math.min(funcExpl.getValue().floatValue(), maxBoost) + queryExpl.getValue().floatValue(),
"sum of",
queryExpl,
minExpl
);
}
},
AVG {
@Override
public float combine(double queryScore, double funcScore, double maxBoost) {
return (float) ((Math.min(funcScore, maxBoost) + queryScore) / 2.0);
}
@Override
public Explanation explain(Explanation queryExpl, Explanation funcExpl, float maxBoost) {
Explanation minExpl = Explanation.match(
Math.min(funcExpl.getValue().floatValue(), maxBoost),
"min of:",
funcExpl,
Explanation.match(maxBoost, "maxBoost")
);
return Explanation.match(
(float) ((Math.min(funcExpl.getValue().floatValue(), maxBoost) + queryExpl.getValue().floatValue()) / 2.0),
"avg of",
queryExpl,
minExpl
);
}
},
MIN {
@Override
public float combine(double queryScore, double funcScore, double maxBoost) {
return (float) (Math.min(queryScore, Math.min(funcScore, maxBoost)));
}
@Override
public Explanation explain(Explanation queryExpl, Explanation funcExpl, float maxBoost) {
Explanation innerMinExpl = Explanation.match(
Math.min(funcExpl.getValue().floatValue(), maxBoost),
"min of:",
funcExpl,
Explanation.match(maxBoost, "maxBoost")
);
return Explanation.match(
Math.min(Math.min(funcExpl.getValue().floatValue(), maxBoost), queryExpl.getValue().floatValue()),
"min of",
queryExpl,
innerMinExpl
);
}
},
MAX {
@Override
public float combine(double queryScore, double funcScore, double maxBoost) {
return (float) (Math.max(queryScore, Math.min(funcScore, maxBoost)));
}
@Override
public Explanation explain(Explanation queryExpl, Explanation funcExpl, float maxBoost) {
Explanation innerMinExpl = Explanation.match(
Math.min(funcExpl.getValue().floatValue(), maxBoost),
"min of:",
funcExpl,
Explanation.match(maxBoost, "maxBoost")
);
return Explanation.match(
Math.max(Math.min(funcExpl.getValue().floatValue(), maxBoost), queryExpl.getValue().floatValue()),
"max of:",
queryExpl,
innerMinExpl
);
}
};
public abstract float combine(double queryScore, double funcScore, double maxBoost);
public abstract Explanation explain(Explanation queryExpl, Explanation funcExpl, float maxBoost);
@Override
public void writeTo(StreamOutput out) throws IOException {
out.writeEnum(this);
}
public static CombineFunction readFromStream(StreamInput in) throws IOException {
return in.readEnum(CombineFunction.class);
}
public static CombineFunction fromString(String combineFunction) {
return valueOf(combineFunction.toUpperCase(Locale.ROOT));
}
}