← Back to branch summary

~ubuntu-branches/ubuntu/maverick/commons-math/maverick

« back to all changes in this revision

Viewing changes to src/main/java/org/apache/commons/math/optimization/general/Preconditioner.java

  • Committer: Bazaar Package Importer
  • Author(s): Damien Raude-Morvan
  • Date: 2009-08-22 01:13:25 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20090822011325-hi4peq1ua5weguwn
Tags: 2.0-1
* New upstream release.
* Set Maintainer field to Debian Java Team
* Add myself as Uploaders
* Switch to Quilt patch system:
  - Refresh all patchs
  - Remove B-D on dpatch, Add B-D on quilt
  - Include patchsys-quilt.mk in debian/rules
* Bump Standards-Version to 3.8.3:
  - Add a README.source to describe patch system
* Maven POMs:
  - Add a Build-Depends-Indep dependency on maven-repo-helper
  - Use mh_installpom and mh_installjar to install the POM and the jar to the
    Maven repository
* Use default-jdk/jre:
  - Depends on java5-runtime-headless
  - Build-Depends on default-jdk
  - Use /usr/lib/jvm/default-java as JAVA_HOME
* Move api documentation to /usr/share/doc/libcommons-math-java/api
* Build-Depends on junit4 instead of junit

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/main/java/org/apache/commons/math/optimization/general/Preconditioner.java
 
1
/*
 
2
 * Licensed to the Apache Software Foundation (ASF) under one or more
 
3
 * contributor license agreements.  See the NOTICE file distributed with
 
4
 * this work for additional information regarding copyright ownership.
 
5
 * The ASF licenses this file to You under the Apache License, Version 2.0
 
6
 * (the "License"); you may not use this file except in compliance with
 
7
 * the License.  You may obtain a copy of the License at
 
8
 *
 
9
 *      http://www.apache.org/licenses/LICENSE-2.0
 
10
 *
 
11
 * Unless required by applicable law or agreed to in writing, software
 
12
 * distributed under the License is distributed on an "AS IS" BASIS,
 
13
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 
14
 * See the License for the specific language governing permissions and
 
15
 * limitations under the License.
 
16
 */
 
17
 
 
18
package org.apache.commons.math.optimization.general;
 
19
 
 
20
import org.apache.commons.math.FunctionEvaluationException;
 
21
 
 
22
/** 
 
23
 * This interface represents a preconditioner for differentiable scalar
 
24
 * objective function optimizers.
 
25
 * @version $Revision: 782468 $ $Date: 2009-06-07 17:24:18 -0400 (Sun, 07 Jun 2009) $
 
26
 * @since 2.0
 
27
 */
 
28
public interface Preconditioner {
 
29
 
 
30
    /** 
 
31
     * Precondition a search direction.
 
32
     * <p>
 
33
     * The returned preconditioned search direction must be computed fast or
 
34
     * the algorithm performances will drop drastically. A classical approach
 
35
     * is to compute only the diagonal elements of the hessian and to divide
 
36
     * the raw search direction by these elements if they are all positive.
 
37
     * If at least one of them is negative, it is safer to return a clone of
 
38
     * the raw search direction as if the hessian was the identity matrix. The
 
39
     * rationale for this simplified choice is that a negative diagonal element
 
40
     * means the current point is far from the optimum and preconditioning will
 
41
     * not be efficient anyway in this case.
 
42
     * </p>
 
43
     * @param point current point at which the search direction was computed
 
44
     * @param r raw search direction (i.e. opposite of the gradient)
 
45
     * @return approximation of H<sup>-1</sup>r where H is the objective function hessian
 
46
     * @exception FunctionEvaluationException if no cost can be computed for the parameters
 
47
     * @exception IllegalArgumentException if point dimension is wrong
 
48
     */
 
49
    double[] precondition(double[] point, double[] r)
 
50
        throws FunctionEvaluationException, IllegalArgumentException;
 
51
 
 
52
}