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 inplace and on new object instances. These operators work on object types
035 * 
036 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
037 * 
038 * @param <OBJECT> The object type to be returned 
039 */
040public interface ObjectArithmetic<OBJECT> {
041        /**
042         * Add to a copy of this.
043         * @param s add s to a copy of this
044         * @return a new instance of this 
045         */
046        public OBJECT add(OBJECT s);
047        
048        /**
049         * Add to this.
050         * @param s add s to this
051         * @return this (for convenience)
052         */
053        public OBJECT addInplace(OBJECT s);
054        
055        /**
056         * Subtract from a copy of this.
057         * @param s minus a copy of this by s
058         * @return a new instance of this 
059         */
060        public OBJECT subtract(OBJECT s);
061        
062        /**
063         * Subtract from this.
064         * @param s minus this by s
065         * @return this (for convenience)
066         */
067        public OBJECT subtractInplace(OBJECT s);
068        
069        /**
070         * Multiply a copy of this.
071         * @param s times a copy of this by s
072         * @return a new instance of this 
073         */
074        public OBJECT multiply(OBJECT s);
075        
076        /**
077         * Multiply this.
078         * @param s times this by s
079         * @return this (for convenience)
080         */
081        public OBJECT multiplyInplace(OBJECT s);
082        
083        /**
084         * Divide a copy of this.
085         * @param s divide a copy of this by s
086         * @return a new instance of this 
087         */
088        public OBJECT divide(OBJECT s);
089        
090        /**
091         * Divide this.
092         * @param s divide this by s
093         * @return this (for convenience)
094         */
095        public OBJECT divideInplace(OBJECT s);  
096}