001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.util.math;
031
032/**
033 * Implementing classes provide a set of simple arithmetic operators which can be
034 * applied both in-place and on new object instances. These operators work on scalars.
035 * 
036 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
037 * @param <OBJECT> The object type to be returned 
038 * @param <SCALAR> The scalar type to be added
039 *
040 */
041public interface ScalarArithmetic<OBJECT, SCALAR extends Number> {
042        /**
043         * Add to a copy of this.
044         * @param s add s to a copy of this
045         * @return a new instance of this 
046         */
047        public OBJECT add(SCALAR s);
048        
049        /**
050         * Add to this.
051         * @param s add s to this
052         * @return this (for convenience)
053         */
054        public OBJECT addInplace(SCALAR s);
055        
056        /**
057         * Subtract from a copy of this.
058         * @param s minus a copy of this by s
059         * @return a new instance of this 
060         */
061        public OBJECT subtract(SCALAR s);
062        
063        /**
064         * Subtract from this.
065         * @param s minus this by s
066         * @return this (for convenience)
067         */
068        public OBJECT subtractInplace(SCALAR s);
069        
070        /**
071         * Multiply a copy of this.
072         * @param s times a copy of this by s
073         * @return a new instance of this 
074         */
075        public OBJECT multiply(SCALAR s);
076        
077        /**
078         * Multiply this.
079         * @param s times this by s
080         * @return this (for convenience)
081         */
082        public OBJECT multiplyInplace(SCALAR s);
083        
084        /**
085         * Divide a copy of this.
086         * @param s divide a copy of this by s
087         * @return a new instance of this 
088         */
089        public OBJECT divide(SCALAR s);
090        
091        /**
092         * Divide this.
093         * @param s divide this by s
094         * @return this (for convenience)
095         */
096        public OBJECT divideInplace(SCALAR s);          
097}