nlp-utils/src/main/java/org/apache/opennlp/utils/regression/Hypothesis.java

/*
 * 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.opennlp.utils.regression;

/**
 * An {@link Hypothesis} maps a series of inputs to an output
 */
public interface Hypothesis {

  /**
   * calculate the output given some inputs according to the underlying model.
   *
   * @param inputs an array of inputs as <code>double</code>
   * @return a <code>double</code> representing the output
   */
  public double calculateOutput(double[] inputs);

  /**
   * update the internal model's parameters.
   *
   * @param parameters an array of <code>double</code> containing the updated parameters
   */
  public void updateParameters(double[] parameters);
}