org.integratedmodelling.api.modelling.INumericObserver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of klab-api Show documentation
The newest version!
/*******************************************************************************
 *  Copyright (C) 2007, 2015:
 *  
 *    - Ferdinando Villa 
 *    - integratedmodelling.org
 *    - any other authors listed in @author annotations
 *
 *    All rights reserved. This file is part of the k.LAB software suite,
 *    meant to enable modular, collaborative, integrated 
 *    development of interoperable data and model components. For
 *    details, see http://integratedmodelling.org.
 *    
 *    This program is free software; you can redistribute it and/or
 *    modify it under the terms of the Affero General Public License 
 *    Version 3 or any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but without any warranty; without even the implied warranty of
 *    merchantability or fitness for a particular purpose.  See the
 *    Affero General Public License for more details.
 *  
 *     You should have received a copy of the Affero General Public License
 *     along with this program; if not, write to the Free Software
 *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *     The license is also available at: https://www.gnu.org/licenses/agpl.html
 *******************************************************************************/
package org.integratedmodelling.api.modelling;

import org.integratedmodelling.api.knowledge.IConcept;

/**
 * Numeric observers produce numeric states but may have a discretization. Numeric
 * states may be probabilistic, too.
 * 
 * @author Ferd
 */
public interface INumericObserver extends IObserver {

    /**
     * Return the discretization if any, or null.
     * 
     * @return the discretization, or null
     */
    IClassification getDiscretization();

    /**
     * If a minimum value is defined, return it, otherwise return negative infinity.
     * @return the minimum value or Double.NEGATIVE_INFINITY
     */
    double getMinimumValue();

    /**
     * If a maximum value is defined, return it, otherwise return infinity.
     * @return the maximum value or Double.POSITIVE_INFINITY
     */
    double getMaximumValue();
    
    /**
     * If the observer is discretizing the observable 'by' some trait or
     * ordering, get the undiscretized original observable, otherwise 
     * return the unmodified type.
     * 
     * @return
     */
    IConcept getUndiscretizedObservable();

}