/*
 * Licensed 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 com.facebook.presto.ml;

import com.facebook.presto.spi.function.AccumulatorState;
import com.facebook.presto.spi.function.AccumulatorStateMetadata;
import com.google.common.collect.BiMap;
import io.airlift.slice.Slice;

import javax.validation.constraints.NotNull;

import java.util.List;

@AccumulatorStateMetadata(stateSerializerClass = LearnStateSerializer.class, stateFactoryClass = LearnStateFactory.class)
public interface LearnState
        extends AccumulatorState
{
    // Mapping of string labels for classifiers that use strings instead of doubles
    @NotNull
    BiMap<String, Integer> getLabelEnumeration();

    int enumerateLabel(String label);

    @NotNull
    List<Double> getLabels();

    @NotNull
    List<FeatureVector> getFeatureVectors();

    Slice getParameters();

    void setParameters(Slice parameters);

    void addMemoryUsage(long value);
}
