/* 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.nn;

import org.tensorflow.Operand;
import org.tensorflow.Operation;
import org.tensorflow.OperationBuilder;
import org.tensorflow.Output;
import org.tensorflow.op.Operands;
import org.tensorflow.op.RawOp;
import org.tensorflow.op.Scope;
import org.tensorflow.op.annotation.Endpoint;
import org.tensorflow.op.annotation.Operator;
import org.tensorflow.types.TFloat32;
import org.tensorflow.types.TInt32;
import org.tensorflow.types.family.TNumber;

/**
 * Solves a batch of isotonic regression problems.
 * 
 * @param <U> data type for {@code output()} output
 */
public final class IsotonicRegression<U extends TNumber> extends RawOp {
  
  /**
   * Factory method to create a class wrapping a new IsotonicRegression operation.
   * 
   * @param scope current scope
   * @param input A (batch_size, dim)-tensor holding a batch of inputs.
   * @param outputDtype Dtype of output.
   * @return a new instance of IsotonicRegression
   */
  @Endpoint(describeByClass = true)
  public static <U extends TNumber> IsotonicRegression<U> create(Scope scope, Operand<? extends TNumber> input, Class<U> outputDtype) {
    OperationBuilder opBuilder = scope.env().opBuilder("IsotonicRegression", scope.makeOpName("IsotonicRegression"));
    opBuilder.addInput(input.asOutput());
    opBuilder = scope.apply(opBuilder);
    opBuilder.setAttr("output_dtype", Operands.toDataType(outputDtype));
    return new IsotonicRegression<U>(opBuilder.build());
  }
  
  /**
   * Factory method to create a class wrapping a new IsotonicRegression operation using default output types.
   * 
   * @param scope current scope
   * @param input A (batch_size, dim)-tensor holding a batch of inputs.
   * @return a new instance of IsotonicRegression
   */
  @Endpoint(describeByClass = true)
  public static IsotonicRegression<TFloat32> create(Scope scope, Operand<? extends TNumber> input) {
    return create(scope, input, TFloat32.class);
  }
  
  /**
   * A (batch_size, dim)-tensor holding the per-batch element solutions.
   */
  public Output<U> output() {
    return output;
  }
  
  /**
   * An int32 (batch_size, dim)-tensor with the segments.
   */
  public Output<TInt32> segments() {
    return segments;
  }
  
  /** The name of this op, as known by TensorFlow core engine */
  public static final String OP_NAME = "IsotonicRegression";
  
  private Output<U> output;
  private Output<TInt32> segments;
  
  private IsotonicRegression(Operation operation) {
    super(operation);
    int outputIdx = 0;
    output = operation.output(outputIdx++);
    segments = operation.output(outputIdx++);
  }
}
