org.apache.flink.ml.feature.robustscaler.RobustScalerParams Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flink-ml-lib Show documentation

The newest version!

/*
 * 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.flink.ml.feature.robustscaler;

import org.apache.flink.ml.common.param.HasRelativeError;
import org.apache.flink.ml.param.DoubleParam;
import org.apache.flink.ml.param.Param;
import org.apache.flink.ml.param.ParamValidators;

/**
 * Params for {@link RobustScaler}.
 *
 * @param  The class type of this instance.
 */
public interface RobustScalerParams extends HasRelativeError, RobustScalerModelParams {
    Param LOWER =
            new DoubleParam(
                    "lower",
                    "Lower quantile to calculate quantile range.",
                    0.25,
                    ParamValidators.inRange(0.0, 1.0, false, false));

    Param UPPER =
            new DoubleParam(
                    "upper",
                    "Upper quantile to calculate quantile range.",
                    0.75,
                    ParamValidators.inRange(0.0, 1.0, false, false));

    default double getLower() {
        return get(LOWER);
    }

    default T setLower(Double value) {
        return set(LOWER, value);
    }

    default double getUpper() {
        return get(UPPER);
    }

    default T setUpper(Double value) {
        return set(UPPER, value);
    }
}