Package org.opensearch.ml.common.input.parameter.clustering

Class KMeansParams

java.lang.Object

org.opensearch.ml.common.input.parameter.clustering.KMeansParams

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, MLAlgoParams

public class KMeansParams
extends Object
implements MLAlgoParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KMeansParams.DistanceType
static class	KMeansParams.KMeansParamsBuilder

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CENTROIDS_FIELD
static final String	DISTANCE_TYPE_FIELD
static final String	ITERATIONS_FIELD
static final String	PARSE_FIELD_NAME
static final org.opensearch.core.xcontent.NamedXContentRegistry.Entry	XCONTENT_REGISTRY

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
KMeansParams(Integer centroids, Integer iterations, KMeansParams.DistanceType distanceType)
KMeansParams(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
static KMeansParams.KMeansParamsBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Integer	getCentroids()
KMeansParams.DistanceType	getDistanceType()
Integer	getIterations()
int	getVersion()
String	getWriteableName()
int	hashCode()
static MLAlgoParams	parse(org.opensearch.core.xcontent.XContentParser parser)
void	setCentroids(Integer centroids)
void	setDistanceType(KMeansParams.DistanceType distanceType)
void	setIterations(Integer iterations)
KMeansParams.KMeansParamsBuilder	toBuilder()
String	toString()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

PARSE_FIELD_NAME

public static final String PARSE_FIELD_NAME

XCONTENT_REGISTRY

public static final org.opensearch.core.xcontent.NamedXContentRegistry.Entry XCONTENT_REGISTRY

CENTROIDS_FIELD

public static final String CENTROIDS_FIELD

See Also:

• Constant Field Values

ITERATIONS_FIELD

public static final String ITERATIONS_FIELD

See Also:

• Constant Field Values

DISTANCE_TYPE_FIELD

public static final String DISTANCE_TYPE_FIELD

See Also:

• Constant Field Values

Constructor Details

KMeansParams

public KMeansParams(Integer centroids,
 Integer iterations,
 KMeansParams.DistanceType distanceType)

KMeansParams

public KMeansParams(org.opensearch.core.common.io.stream.StreamInput in)
             throws IOException

Throws:

IOException

Method Details

parse

public static MLAlgoParams parse(org.opensearch.core.xcontent.XContentParser parser)
                          throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

getVersion

public int getVersion()

Specified by:

getVersion in interface MLAlgoParams

builder

public static KMeansParams.KMeansParamsBuilder builder()

toBuilder

public KMeansParams.KMeansParamsBuilder toBuilder()

getCentroids

public Integer getCentroids()

getIterations

public Integer getIterations()

getDistanceType

public KMeansParams.DistanceType getDistanceType()

setCentroids

public void setCentroids(Integer centroids)

setIterations

public void setIterations(Integer iterations)

setDistanceType

public void setDistanceType(KMeansParams.DistanceType distanceType)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object