## Uses of Interface
org.apache.ignite.binary.BinaryObject

- Packages that use BinaryObject
  Package | Description
  --- | ---
  org.apache.ignite | Contains entry-point Ignite & HPC APIs.
  org.apache.ignite.binary | Contains Ignite Binary Objects API classes.
  org.apache.ignite.ml.dataset.feature.extractor.impl | Package contains default implementations of `Vectorizer`.
  org.apache.ignite.ml.recommendation | Contains recommendation system framework.
  org.apache.ignite.ml.recommendation.util | Contains util classes used in recommendation system framework.
  org.apache.ignite.ml.sql | Contains util classes that help to work with machine learning models in SQL and train models on data from SQL tables.

- - ### Uses of BinaryObject in org.apache.ignite

    Methods in org.apache.ignite that return BinaryObject
    Modifier and Type | Method and Description
    --- | ---
    `BinaryObject` | IgniteBinary.`buildEnum(String typeName, int ord)` Create enum object using value.
    `BinaryObject` | IgniteBinary.`buildEnum(String typeName, String name)` Create enum object using name.

    Methods in org.apache.ignite with parameters of type BinaryObject
    Modifier and Type | Method and Description
    --- | ---
    `BinaryObjectBuilder` | IgniteBinary.`builder(BinaryObject binaryObj)` Creates binary builder initialized by existing binary object.

  - ### Uses of BinaryObject in org.apache.ignite.binary

    Methods in org.apache.ignite.binary that return BinaryObject
    Modifier and Type | Method and Description
    --- | ---
    `BinaryObject` | BinaryObjectBuilder.`build()` Builds binary object.
    `BinaryObject` | BinaryObject.`clone()` Copies this binary object.

    Methods in org.apache.ignite.binary that return types with arguments of type BinaryObject
    Modifier and Type | Method and Description
    --- | ---
    `Collection<BinaryObject>` | BinaryType.`enumValues()`

    Methods in org.apache.ignite.binary with parameters of type BinaryObject
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | BinaryField.`exists(BinaryObject obj)` Check whether field exists in the object.
    `<T> T` | BinaryField.`value(BinaryObject obj)` Get field's value from the given object.

  - ### Uses of BinaryObject in org.apache.ignite.ml.dataset.feature.extractor.impl

    Methods in org.apache.ignite.ml.dataset.feature.extractor.impl with parameters of type BinaryObject
    Modifier and Type | Method and Description
    --- | ---
    `protected List<String>` | BinaryObjectVectorizer.`allCoords(K key, BinaryObject value)` Returns list of all coordinate with feature values.
    `protected Double` | BinaryObjectVectorizer.`feature(String coord, K key, BinaryObject value)` Extracts feature value by given coordinate.

  - ### Uses of BinaryObject in org.apache.ignite.ml.recommendation

    Method parameters in org.apache.ignite.ml.recommendation with type arguments of type BinaryObject
    Modifier and Type | Method and Description
    --- | ---
    `RecommendationModel<Serializable,Serializable>` | RecommendationTrainer.`fit(DatasetBuilder<Object,BinaryObject> datasetBuilder, String objFieldName, String subjFieldName, String ratingFieldName)` Fits prediction model on a data stored in binary format.
    `RecommendationModel<Serializable,Serializable>` | RecommendationTrainer.`update(DatasetBuilder<Object,BinaryObject> datasetBuilder, String objFieldName, String subjFieldName, String ratingFieldName, RecommendationModel<Serializable,Serializable> mdl)` Updates prediction model on a data stored in binary format.

  - ### Uses of BinaryObject in org.apache.ignite.ml.recommendation.util

    Method parameters in org.apache.ignite.ml.recommendation.util with type arguments of type BinaryObject
    Modifier and Type | Method and Description
    --- | ---
    `RecommendationDatasetData<Serializable,Serializable>` | RecommendationBinaryDatasetDataBuilder.`build(LearningEnvironment env, Iterator<UpstreamEntry<Object,BinaryObject>> upstreamData, long upstreamDataSize, EmptyContext ctx)` Builds a new partition `data` from a partition `upstream` data and partition `context`.

  - ### Uses of BinaryObject in org.apache.ignite.ml.sql

    Constructor parameters in org.apache.ignite.ml.sql with type arguments of type BinaryObject
    Constructor and Description
    `SqlDatasetBuilder(Ignite ignite, String upstreamCache, IgniteBiPredicate<Object,BinaryObject> filter)` Constructs a new instance of cache based dataset builder that makes `CacheBasedDataset`.
    `SqlDatasetBuilder(Ignite ignite, String upstreamCache, IgniteBiPredicate<Object,BinaryObject> filter, UpstreamTransformerBuilder transformerBuilder)` Constructs a new instance of cache based dataset builder that makes `CacheBasedDataset`.

${current.year} Copyright © Apache Software Foundation
| Follow @ApacheIgnite
Ignite Database and Caching Platform | : ver. 2.15.0
Release Date | : April 25 2023