mmf
Class MMF_RunningSum

Object
  common:Generic
      common:Transform
          common:UserTransform
              mmf:MMF_RunningSum

class 
UserTransform:MMF_RunningSum

Returns the sum of pz and all previous values of pz

Ultra Fractal Source

Toggle UF Source Code Display

 class MMF_RunningSum(common.ulb:UserTransform) {
 ; Returns the sum of pz and all previous values of pz<br>
 public:
   import "common.ulb"
   
   ; @param pparent the parent, generally "this" for the parent, or zero
   func MMF_RunningSum(Generic pparent)
     UserTransform.UserTransform(pparent)
   endfunc
 
   func Init(complex pz)
 ;    m_Iterations = 0 not used in this transform
     m_Solid = false
     m_Sum = (0,0)
   endfunc
 
   complex func Iterate(complex pz)
 ;    m_Iterations = m_Iterations + 1 not used in this transform
     return m_Sum = m_Sum + pz
   endfunc
 
   func IterateSilent()
 ;    m_Iterations = m_Iterations + 1 not used in this transform
     if @p_restart
       m_Sum = (0,0)
     endif
   endfunc
 
 protected:
   complex m_Sum
 
 default:
   title = "Running Sum"
   bool param p_restart
     caption = "Reset the Sum"
     default = false
     hint = "This is only for when the transform is used in a situation \
             where there may be iteration skipping, for example in a \
             colouring formula. If you enable this option then the sum \
             is reset to zero each time iteration skipping occurs."
   endparam
 }
 

Constructor Summary

MMF_RunningSum()

MMF_RunningSum(Generic pparent)

Method Summary

void	Init(complex pz) Set up for a sequence of values
complex	Iterate(complex pz) Transform a single point within a sequence
void	IterateSilent() Update internal counters without transforming a point

Methods inherited from class common:Transform

IsSolid

Methods inherited from class common:Generic

GetParent

Methods inherited from class Object

Constructor Detail

MMF_RunningSum

public MMF_RunningSum(Generic pparent)

Parameters:

pparent - the parent, generally "this" for the parent, or zero

MMF_RunningSum

public MMF_RunningSum()

Method Detail

Init

public void Init(complex pz)

Description copied from class: Transform

Set up for a sequence of values

This function will be called at the beginning of each sequence of values (e.g. at the beginning of each fractal orbit). It will be called even if only one value is being transformed (e.g. a normal transformation formula). Use this to perform any setup that is exactly the same for each value in the sequence being transformed.

Overrides:

Init in class Transform

Parameters:

pz - the value representing the sequence; for a normal transformation formula use, this will be #pixel. In some cases this may differ from the first value passed to Iterate() if the calling code applies some other transformations.

Iterate

public complex Iterate(complex pz)

Description copied from class: Transform

Transform a single point within a sequence

After a sequence has been set up with Init(), this function will be called once for each value in the sequence. Note that all values in the sequence must be processed in order (they cannot be processed out of order). If the sequence contains only one value, Init() will still be called and then Iterate() will be called just once.

Overrides:

Iterate in class Transform

Parameters:

pz - the complex value to be transformed

Returns:

the transformed value

IterateSilent

public void IterateSilent()

Description copied from class: Transform

Update internal counters without transforming a point

For some Transform classes, the actual transformation being performed changes for each value in the sequence (e.g. TrapTransform, which can rotate each iteration by a different amount). In some cases the calling code may determine in advance that a particular point does not need to be transformed (perhaps because it is not being used) but it still needs to be accounted for. This function is used in place of Iterate() for those situations; the Transform should update any internal state that changes between iterations within a sequence. Since no value is being transformed, no parameters are passed and no return value is provided.

Overrides:

IterateSilent in class Transform