plonk_Variable.h

/*
 -------------------------------------------------------------------------------
 This file is part of the Plink, Plonk, Plank libraries
  by Martin Robinson
 
 http://code.google.com/p/pl-nk/
 
 Copyright University of the West of England, Bristol 2011-14
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 * Neither the name of University of the West of England, Bristol nor 
   the names of its contributors may be used to endorse or promote products
   derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 DISCLAIMED. IN NO EVENT SHALL UNIVERSITY OF THE WEST OF ENGLAND, BRISTOL BE 
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 
 This software makes use of third party libraries. For more information see:
 doc/license.txt included in the distribution.
 -------------------------------------------------------------------------------
 */

#ifndef PLONK_VARIABLE_H
#define PLONK_VARIABLE_H

#include "plonk_VariableForwardDeclarations.h"
#include "../plonk_DynamicContainer.h"

#include "../../core/plonk_SmartPointerContainer.h"
#include "../../core/plonk_WeakPointerContainer.h"
#include "../../core/plonk_SenderContainer.h"

#include "../../maths/plonk_InlineUnaryOps.h"
#include "../../maths/plonk_InlineBinaryOps.h"
#include "../../maths/plonk_InlineMiscOps.h"

#include "../../random/plonk_RNG.h"
#include "../plonk_Text.h"

template<class Type>
class Variable : public SenderContainer< VariableInternalBase<Type> >
{
public:
    typedef VariableInternalBase<Type>      Internal;
    typedef VariableInternal<Type>          VariableInternalType;
    typedef SenderContainer<Internal>       Base;
    typedef ReceiverInternal<Variable>      Receiver;
    typedef Variable                        Sender;
    typedef WeakPointerContainer<Variable>  Weak;
    typedef UnitBase<Type>                  UnitType;

    typedef typename BinaryOpFunctionsHelper<Type>::BinaryOpFunctionsType BinaryOpFunctionsType;
    typedef typename UnaryOpFunctionsHelper<Type>::UnaryOpFunctionsType UnaryOpFunctionsType;

    typedef PatternVariableInternal<Type>   PatternVariableInternalType;
    typedef NumericalArray<Variable>        PatternType;
    
    inline Variable() throw()
    :   Base (new VariableInternalType (Type()))
    {
    }
    
    explicit Variable (Internal* internal) throw()
    :   Base (internal)
    {
    }   
    
    inline Variable (Variable const& copy) throw()
    :   Base (static_cast<Base const&> (copy))
    {
    }
    
    Variable (Dynamic const& other) throw()
    :   Base (other.as<Variable>().getInternal())
    {
    }    
    
    Variable& operator= (Variable const& other) throw()
        {
                if (this != &other)
            this->setInternal (other.getInternal());
        
        return *this;
        }
    
    static Variable fromWeak (Weak const& weak) throw()
    {
        return weak.fromWeak();
    }
            
    static const Variable& getNull() throw()
        {
                static Variable null;
                return null;
        }                       
    
    inline Variable (Type const& initValue) throw()
    :   Base (new VariableInternalType (initValue))
    {
    }
    
    Variable (PatternType const& pat) throw()
    :   Base (new PatternVariableInternalType (pat))
    {
    }
    
    template<class OtherType>
    Variable (NumericalArray< Variable<OtherType> > const& pat) throw()
    :   Base (new TypeVariableInternal<Type,OtherType> (Variable<OtherType> (static_cast< VariableInternalBase<OtherType>* > (new PatternVariableInternal<OtherType> (pat)))))
    {
        // what a nasty expression!
    }
    
    template<class OtherType>
    inline Variable (OtherType const& other) throw()
    :   Base (new TypeVariableInternal<Type,OtherType> (other))
    {
    }
    
    template<class ValueType>
    Variable& operator= (ValueType const& newValue) throw()
    {
        this->setValue (newValue);
        return *this;
    }
    
    inline const Type getValue() const throw()
    {
        return this->getInternal()->getValue();
    }
    
    inline Type* getValuePtr() throw()
    {
        return this->getInternal()->getValuePtr();
    }
    
    inline operator Type () const throw()
    {
        return this->getInternal()->getValue();
    }
    
    inline const Type nextValue() throw()
    {
        return this->getInternal()->nextValue();
    }
    
    inline void setValue (Type const& newValue) throw()
    {
        this->getInternal()->setValue (newValue);
    }    
    
    inline void swapValues (Type& other) throw()
    {
        this->getInternal()->swapValues (other);
    }
                    
    template<PLONK_BINARYOPFUNCTION(Type, op)>
    Variable binary (Variable const& rightOperand) const throw()
    {
        Internal* internal = new BinaryOpVariableInternal<Type,op> (*this, rightOperand);
        return Variable (internal);
    }
    
    template<PLONK_UNARYOPFUNCTION(Type, op)>
    Variable unary() const throw()
    {
        Internal* internal = new UnaryOpVariableInternal<Type,op> (*this);
        return Variable (internal);
    }
    
    PLONK_BINARYOPS(Variable)
    PLONK_UNARYOPS(Variable)
    
    Variable linlin (Variable const& inLow, Variable const& inHigh, Variable const& outLow, Variable const& outHigh) const throw()
    {
        return plonk::linlin (*this, inLow, inHigh, outLow, outHigh);
    }
    
    Variable linexp (Variable const& inLow, Variable const& inHigh, Variable const& outLow, Variable const& outHigh) const throw()
    {
        return plonk::linexp (*this, inLow, inHigh, outLow, outHigh);
    }
    
    Variable explin (Variable const& inLow, Variable const& inHigh, Variable const& outLow, Variable const& outHigh) const throw()
    {
        return plonk::explin (*this, inLow, inHigh, outLow, outHigh);
    }
    
    Variable linwelch (Variable const& inLow, Variable const& inHigh, Variable const& outLow, Variable const& outHigh) const throw()
    {
        return plonk::linwelch (*this, inLow, inHigh, outLow, outHigh);
    }

    
    typedef ShapeVariableInternal<Type>     ShapeVariableInternalType;
    typedef IntVariable                     StepsVariable;
    typedef Variable<Shape::ShapeType>      ShapeTypeVariable;
    typedef FloatVariable                   CurveVariable;
    
    Variable shape (StepsVariable const& numSteps) const throw()
    {
        Internal* internal = new ShapeVariableInternalType (*this, numSteps, Shape::Linear, 0.f);
        return Variable (internal);
    }
    
    Variable shape (StepsVariable const& numSteps,
                    ShapeTypeVariable const& shapeType) const throw()
    {
        Internal* internal = new ShapeVariableInternalType (*this, numSteps, shapeType, 0.f);
        return Variable (internal);
    }
    
    Variable shape (StepsVariable const& numSteps,
                    ShapeTypeVariable const& shapeType,
                    CurveVariable const& curve) const throw()
    {
        Internal* internal = new ShapeVariableInternalType (*this, numSteps, shapeType, curve);
        return Variable (internal);
    }
    
    Variable selectMin (Variable const& other) const throw()
    {
        return (this->getValue() > other.getValue()) ? other : *this;
    }    
    
    Variable selectMax (Variable const& other) const throw()
    {
        return (this->getValue() < other.getValue()) ? other : *this;
    }
            
    int getTypeCode() const throw()
    {
        return TypeUtility<Variable>::getTypeCode();
    }
    
    int getValueTypeCode() const throw()
    {
        return TypeUtility<Type>::getTypeCode();
    }        
    
    inline UnitType ar() const throw()
    {
        return UnitType (*this).ar();
    }
    
    inline UnitType kr() const throw()
    {
        return UnitType (*this).kr();
    }
    
    inline UnitType ar (const Interp::TypeCode interpType) const throw()
    {
        return UnitType (*this).ar (interpType);
    }
    
    inline UnitType kr (const Interp::TypeCode interpType) const throw()
    {
        return UnitType (*this).kr (interpType);
    }
};

PLONK_BINARYOPGLOBALS_TEMPLATE(Variable,Type); // declares global functions with the same name as the binary operators
PLONK_UNARYOPGLOBALS_TEMPLATE(Variable,Type);  // declares global functions with the same name as the unary operators

template<class Type>
inline UnitBase<Type> ar (Variable<Type> v) throw()
{
    return UnitBase<Type> (v).ar();
}

template<class Type>
inline UnitBase<Type> kr (Variable<Type> v) throw()
{
    return UnitBase<Type> (v).kr();
}

#if !PLONK_ANDROID
template<class Type>
std::istream& operator>> (std::istream &inputStream, Variable<Type>& variable)
{
    Type value;
    inputStream >> value;
    
    variable = Variable<Type> (value);
    
    return inputStream;
}

template<class Type>
std::ostream& operator<< (std::ostream &outputStream, Variable<Type> const& variable)
{
    outputStream << variable.getValue();
    return outputStream;
}
#endif
    
//BINARYOPGLOBALS(Variable) // declares global functions with the same name as the binary operators
//UNARYOPGLOBALS(Variable)  // declares global functions with the same name as the unary operators

template<class Type>
class Variable<Type&> : public SmartPointerContainer< VariableInternal<Type&> >
{
public:
    typedef VariableInternal<Type&>         Internal;
    typedef SmartPointerContainer<Internal> Base;
    
    Variable()
    :   Base (new Internal (Type()))
    {
    }
    
    Variable (Variable const& copy) throw()
        :       Base (static_cast<Base const&> (copy))
        {
        }        
    
    Variable (Type& initValue) throw()
    :   Base (new Internal (initValue))
    {
    }
    
    template<class ValueType>
    Variable (ValueType const& initValue) throw()
    :   Base (new Internal (initValue))
    {
    }    
            
    template<class ValueType>
    inline Variable& operator= (ValueType const& newValue) throw()
    {
        Type temp (newValue);
        this->swapValues (temp);
        return *this;
    }    
    
    inline Variable& operator= (Variable const& other) throw()
    {
        Variable temp (other.getValue());
        this->swapValues (temp);
        return *this;
    }    

    inline Type& getValue() throw()
    {
        return this->getInternal()->getValue();
    }
    
    inline const Type& getValue() const throw()
    {
        return this->getInternal()->getValue();
    }
    
    inline operator Type& () throw()
    {
        return this->getInternal()->getValue();
    }
    
    template<class ValueType>
    inline operator ValueType() throw()
    {
        return ValueType (this->getInternal()->getValue());
    }
    
    template<class ValueType>
    inline void setValue (ValueType const& newValue) throw()
    {
        this->getInternal()->setValue (newValue);
    }    
    
    inline void swapValues (Type& other) throw()
    {
        this->getInternal()->swapValues (other);
    }
    
    inline void swapValues (Variable& other) throw()
    {
        this->getInternal()->swapValues (other.getValue());
    }
    
    inline bool isValueNull() const throw()
    {
        return this->getInternal()->getValue().isNull();
    }

    inline bool isValueNotNull() const throw()
    {
        return this->getInternal()->getValue().isNotNull();
    }
    
    PLONK_OBJECTARROWOPERATOR(Variable);
};


#endif // PLONK_VARIABLE_H