org.tensorflow.op.math.SegmentMax Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tensorflow Show documentation
The newest version!
/* Copyright 2018 The TensorFlow Authors. All Rights Reserved.

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.
=======================================================================*/

// This class has been generated, DO NOT EDIT!

package org.tensorflow.op.math;

import org.tensorflow.Operand;
import org.tensorflow.Operation;
import org.tensorflow.OperationBuilder;
import org.tensorflow.Output;
import org.tensorflow.op.PrimitiveOp;
import org.tensorflow.op.Scope;
import org.tensorflow.op.annotation.Operator;

/**
 * Computes the maximum along segments of a tensor.
 * 
 * Read
 * [the section on segmentation](https://tensorflow.org/api_docs/python/tf/math#Segmentation)
 * for an explanation of segments.
 * 

 * Computes a tensor such that
 * \\(output_i = \max_j(data_j)\\) where `max` is over `j` such
 * that `segment_ids[j] == i`.
 * 

 * If the max is empty for a given segment ID `i`, `output[i] = 0`.
 * 

 * 

 * 
 * 
 * 
 * For example:
 * 
{@code
 * c = tf.constant([[1,2,3,4], [4, 3, 2, 1], [5,6,7,8]])
 * tf.segment_max(c, tf.constant([0, 0, 1]))
 * # ==> [[4, 3, 3, 4],
 * #      [5, 6, 7, 8]]
 * }
 * 
 * 
 * @param  data type for {@code output()} output
 */
@Operator(group = "math")
public final class SegmentMax extends PrimitiveOp implements Operand {
  
  /**
   * Factory method to create a class wrapping a new SegmentMax operation.
   * 
   * @param scope current scope
   * @param data 
   * @param segmentIds A 1-D tensor whose size is equal to the size of `data`'s
   * first dimension.  Values should be sorted and can be repeated.
   * @return a new instance of SegmentMax
   */
  public static  SegmentMax create(Scope scope, Operand data, Operand segmentIds) {
    OperationBuilder opBuilder = scope.env().opBuilder("SegmentMax", scope.makeOpName("SegmentMax"));
    opBuilder.addInput(data.asOutput());
    opBuilder.addInput(segmentIds.asOutput());
    opBuilder = scope.applyControlDependencies(opBuilder);
    return new SegmentMax(opBuilder.build());
  }
  
  /**
   * Has same shape as data, except for dimension 0 which
   * has size `k`, the number of segments.
   */
  public Output output() {
    return output;
  }
  
  @Override
  public Output asOutput() {
    return output;
  }
  
  private Output output;
  
  private SegmentMax(Operation operation) {
    super(operation);
    int outputIdx = 0;
    output = operation.output(outputIdx++);
  }
}