/*
!=======================================================================
!
!  PROGRAM  PHASE-Viewer  (PHASE-Viewer 2014.01 ver.3.3.0)
!
!  Created on 2006/12/07 16:03:59
!  AUTHOR(S): KOGA, Junichiro
!  File : BinaryOperator.java
!  
!  Contact address :  Phase System Consortium
!                     E-mail: phase_system@nims.go.jp URL https://azuma.nims.go.jp
!
!
!   Since 2002, this program set had been intensively developed as a part of the following 
!  national projects supported by the Ministry of Education, Culture, Sports, Science and
!  Technology (MEXT) of Japan; "Frontier Simulation Software for Industrial Science
!  (FSIS)" from 2002 to 2005, "Revolutionary Simulation Software (RSS21)" from 2006 to
!  2008. "Research and Development of Innovative Simulation Software (RISS)" from 2008
!  to 2013. These projects is lead by the Center for Research on Innovative Simulation 
!  Software (CISS), the Institute of Industrial Science (IIS), the University of Tokyo.
!   Since 2013, this program set has been further developed centering on PHASE System
!  Consortium. 
!   The activity of development of this program set has been supervised by Takahisa Ohno.
!
!=======================================================================
 */
package ciss.phase_viewer.common;

/**
 * "二項演算"をサポートしたいクラスが実装すべきインターフェース; 二項演算のオーバーロードの代わりになるか?
 * 各メソッドを必ず実装しなければならないわけではないが, その時はそのむねドキュメントすること. 新しいオブジェクトを作るのは面倒な場合もあるので,
 * 基本的は「自分自身が変化する」という仕組みにしよう.
 * 
 * @author KOGA, Junichiro
 * 
 */
public interface BinaryOperator {
    /**
     * 引数のオブジェクトと自分自身を足し, 結果を返す. this+bo
     * 
     * @param bo
     *            自分と足したいObject; 同じ型である必要がある.
     * @return 結果.
     */
    public void add(BinaryOperator bo);

    /**
     * 自分自身から引数のオブジェクトを引き, 結果を返す. this-bo
     * 
     * @param bo
     *            引きたいObject; 同じ型である必要がある.
     * @return 結果.
     */
    public void subtract(BinaryOperator bo);

    /**
     * 引数のオブジェクトを自分に掛け, 結果を返す. 一応, 可換で無い場合はthisxboとせよ.
     * 
     * @param bo
     *            自分と掛けたいObject; 同じ型である必要がある.
     * @return 結果.
     */
    public void multiply(BinaryOperator bo);

    /**
     * 引数のオブジェクトで自分自身を割り, 結果を返す. this/bo
     * 
     * @param bo
     *            自分と足したいObject; 同じ型である必要がある.
     * @return 結果.
     */
    public void divide(BinaryOperator bo);

}
