plonk_BlockSize.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_BLOCKSIZE_H
#define PLONK_BLOCKSIZE_H

#include "../../containers/variables/plonk_VariableForwardDeclarations.h"
#include "../../containers/variables/plonk_Variable.h"
#include "../../core/plonk_Receiver.h"
#include "../../maths/plonk_InlineCommonOps.h"

class BlockSizeDefault;
class BlockSizeNoPreference;

class BlockSize : public IntVariable
{
public:
    typedef VariableInternal<int>           Internal;
    typedef IntVariable                     Base;    
    typedef WeakPointerContainer<BlockSize> Weak;
    
    BlockSize() throw();
    
    BlockSize (SampleRate const& sampleRate) throw();
    
    BlockSize (const int initValue) throw();
    
    BlockSize (IntVariable const& initValue) throw();
    
    BlockSize (BlockSize const& copy) throw();
    
    BlockSize (BlockSizeDefault const& copy) throw();
    BlockSize (BlockSizeNoPreference const& copy) throw();
        
    template<class OtherType>
    BlockSize (OtherType const& initValue) throw()
    :   Base (initValue)
    {
    }
    
    static BlockSize& getDefault() throw();
    
    static BlockSize& getControlRateBlockSize() throw();
    
    static const BlockSize getFractionOfDefault (IntVariable const& divisor) throw();
    
    static const BlockSize getMultipleOfDefault (IntVariable const& factor) throw();    
    inline static const BlockSize getMultipleOfDefault (const int factor) throw() { return getMultipleOfDefault (IntVariable (factor)); }
   
    static const BlockSize getMultipleOfDefault (DoubleVariable const& factor) throw();    
    inline static const BlockSize getMultipleOfDefault (const double factor) throw() { return getMultipleOfDefault (DoubleVariable (factor)); }

    
    static const BlockSize& noPreference() throw();
    
    static const BlockSize& getBlockSize1() throw();
    
    static BlockSize decide (BlockSize const& inputBlockSize, 
                             BlockSize const& preferredBlockSize) throw();
    
    PLONK_OBJECTARROWOPERATOR(BlockSize);

private:
    static const BlockSize getMultipleOfDefault (SampleRate const& factor) throw();    
};

typedef NumericalArray<BlockSize> BlockSizes;

//------------------------------------------------------------------------------

class BlockSizeDefault : public BlockSize
{
public:
    inline BlockSizeDefault() : BlockSize (BlockSize::getDefault()) { }
};

//------------------------------------------------------------------------------

class BlockSizeNoPreference : public BlockSize
{
public:
    inline BlockSizeNoPreference() : BlockSize (BlockSize::getDefault()) { }
};




#endif // PLONK_BLOCKSIZE_H