org.datavec.api.transform.ReduceOp Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of datavec-api Show documentation

There is a newer version: 1.0.0-M2.1

/*-
 *  * Copyright 2016 Skymind, Inc.
 *  *
 *  *    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 org.datavec.api.transform;

import org.datavec.api.transform.reduce.AggregableColumnReduction;
import org.datavec.api.transform.reduce.Reducer;

/**ReduceOp defines the type of column reductions that can be used when reducing
 * a set of values to a single value.

 *
 * Min: take the minimum value

 * Max: take the maximum value

 * Range: output the value max-min

 * Sum: Reduce by summing all values

 * Mean: Reduce by taking the arithmetic mean of the values

 * Stdev: Reduce by calculating the sample standard deviation

 * Count: Reduce by doing a simple count

 * CountUnique: Reduce by counting the number of unique values

 * TakeFirst: Take the first possible  value in the list

 * TakeLast: Take the last possible value in the list

 *
 * Note: For custom reduction operations with {@link Reducer}
 * , use the {@link AggregableColumnReduction}
 * functionality.
 *
 * @author Alex Black
 */
public enum ReduceOp {
    Prod, Min, Max, Range, //Max - Min
    Append, Prepend, // String operations : concatenate, concatenate with commuted arguments
    Sum, Mean, Stdev, // with Bessel's correction
    UncorrectedStdDev, //without
    Variance, // with Bessel's correction
    PopulationVariance, // without
    Count, CountUnique, TakeFirst, //First value
    TakeLast //Last value

}