cyclops.box

Class MutableDouble

java.lang.Object

cyclops.box.MutableDouble

Type Parameters:

T - Type held inside closed var

All Implemented Interfaces:

To<MutableDouble>, java.util.function.DoubleConsumer, java.util.function.DoubleSupplier, java.util.function.Supplier<java.lang.Double>

public class MutableDouble
extends java.lang.Object
implements To<MutableDouble>, java.util.function.DoubleSupplier, java.util.function.DoubleConsumer, java.util.function.Supplier<java.lang.Double>

Class that represents a Closed Variable In Java 8 because of the effectively final rule references to captured variables can't be changed. e.g.

 
 String var = "hello";
 Runnable r = () -> var ="world";
 

Won't compile because var is treated as if it is final. This can be 'worked around' by using a wrapping object or array. e.g.

 Mutable<String> var =  Mutable.of("hello");
 Runnable r = () -> var.set("world");
 

Constructor Summary

Constructors

Constructor and Description
MutableDouble()

Method Summary

Modifier and Type	Method and Description
void	accept(double value)
static MutableDouble	fromExternal(java.util.function.DoubleSupplier s, java.util.function.DoubleConsumer c) Construct a MutableDouble that gets and sets an external value using the provided Supplier and Consumer e.g.
java.lang.Double	get()
double	getAsDouble()
MutableDouble	mapInput(java.util.function.DoubleUnaryOperator fn) Use the supplied function to perform a lazy map operation when get is called
<T1> Mutable<T1>	mapInputToObj(java.util.function.Function<T1,java.lang.Double> fn) Use the supplied function to perform a lazy map operation when get is called
MutableDouble	mapOutput(java.util.function.DoubleUnaryOperator fn) Use the supplied function to perform a lazy map operation when get is called
<R> Mutable<R>	mapOutputToObj(java.util.function.Function<java.lang.Double,R> fn) Use the supplied function to perform a lazy map operation when get is called
MutableDouble	mutate(java.util.function.DoubleFunction<java.lang.Double> varFn)
static <T> MutableDouble	of(double var) Create a Mutable variable, which can be mutated inside a Closure e.g.
MutableDouble	set(double var)
java.util.stream.DoubleStream	toDoubleStream()
java.util.OptionalDouble	toOptionalDouble()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aol.cyclops2.types.To

to

Methods inherited from interface java.util.function.DoubleConsumer

andThen

Constructor Detail

MutableDouble

public MutableDouble()

Method Detail

of

public static <T> MutableDouble of(double var)

Create a Mutable variable, which can be mutated inside a Closure e.g.

   Mutable<Integer> num = Mutable.of(20);
   
   Stream.of(1,2,3,4).map(i->i*10).peek(i-> num.mutate(n->n+i)).foreach(System.out::println);
   
   System.out.println(num.get());
   //prints 120
  

Parameters:

var - Initial value of Mutable

Returns:

New Mutable instance

fromExternal

public static MutableDouble fromExternal(java.util.function.DoubleSupplier s,
                                         java.util.function.DoubleConsumer c)

Construct a MutableDouble that gets and sets an external value using the provided Supplier and Consumer e.g.

  
    MutableDouble mutable = MutableDouble.fromExternal(()->!this.value,val->!this.value);
 
 

Parameters:

s - Supplier of an external value

c - Consumer that sets an external value

Returns:

MutableDouble that gets / sets an external (mutable) value

mapOutputToObj

public <R> Mutable<R> mapOutputToObj(java.util.function.Function<java.lang.Double,R> fn)

Use the supplied function to perform a lazy map operation when get is called

  
  MutableDouble mutable = MutableDouble.fromExternal(()->!this.value,val->!this.value);
  Mutable<Double> withOverride = mutable.mapOutputToObj(b->{ 
                                                        if(override)
                                                             return 10.0;
                                                         return b;
                                                         });
          
 
 

Parameters:

fn - Map function to be applied to the result when get is called

Returns:

Mutable that lazily applies the provided function when get is called to the return value

mapInputToObj

public <T1> Mutable<T1> mapInputToObj(java.util.function.Function<T1,java.lang.Double> fn)

Use the supplied function to perform a lazy map operation when get is called

  
  MutableDouble mutable = MutableDouble.fromExternal(()->!this.value,val->!this.value);
  Mutable<Double> withOverride = mutable.mapInputToObj(b->{ 
                                                        if(override)
                                                             return 10.0;
                                                         return b;
                                                         });
          
 
 

Parameters:

fn - Map function to be applied to the input when set is called

Returns:

Mutable that lazily applies the provided function when set is called to the input value

mapOutput

public MutableDouble mapOutput(java.util.function.DoubleUnaryOperator fn)

Use the supplied function to perform a lazy map operation when get is called

  
  MutableDouble mutable = MutableDouble.fromExternal(()->!this.value,val->!this.value);
  MutableDouble withOverride = mutable.mapOutput(b->{ 
                                                        if(override)
                                                             return 10.0;
                                                         return b;
                                                         });
          
 
 

Parameters:

fn - Map function to be applied to the result when get is called

Returns:

Mutable that lazily applies the provided function when get is called to the return value

mapInput

public MutableDouble mapInput(java.util.function.DoubleUnaryOperator fn)

Use the supplied function to perform a lazy map operation when get is called

  
  MutableDouble mutable = MutableDouble.fromExternal(()->!this.value,val->!this.value);
  MutableDouble withOverride = mutable.mapInput(b->{ 
                                                        if(override)
                                                             return 10.0;
                                                         return b;
                                                         });
          
 
 

Parameters:

fn - Map function to be applied to the input when set is called

Returns:

Mutable that lazily applies the provided function when set is called to the input value

getAsDouble

public double getAsDouble()

Specified by:

getAsDouble in interface java.util.function.DoubleSupplier

Returns:

Current value

set

public MutableDouble set(double var)

Parameters:

var - New value

Returns:

this object with mutated value

mutate

public MutableDouble mutate(java.util.function.DoubleFunction<java.lang.Double> varFn)

Parameters:

varFn - New value

Returns:

this object with mutated value

toOptionalDouble

public java.util.OptionalDouble toOptionalDouble()

toDoubleStream

public java.util.stream.DoubleStream toDoubleStream()

get

public java.lang.Double get()

Specified by:

get in interface java.util.function.Supplier<java.lang.Double>

accept

public void accept(double value)

Specified by:

accept in interface java.util.function.DoubleConsumer