Class: Google::Apis::SheetsV4::IterativeCalculationSettings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/sheets_v4/classes.rb,
generated/google/apis/sheets_v4/representations.rb,
generated/google/apis/sheets_v4/representations.rb

Overview

Settings to control how circular dependencies are resolved with iterative calculation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ IterativeCalculationSettings

Returns a new instance of IterativeCalculationSettings



2728
2729
2730
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2728

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#convergence_threshold ⇒ Float

When iterative calculation is enabled and successive results differ by less than this threshold value, the calculation rounds stop. Corresponds to the JSON property convergenceThreshold

Returns:

  • (Float) 


2726
2727
2728
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2726

def convergence_threshold
  @convergence_threshold
end

#max_iterations ⇒ Fixnum

When iterative calculation is enabled, the maximum number of calculation rounds to perform. Corresponds to the JSON property maxIterations

Returns:

  • (Fixnum) 


2720
2721
2722
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2720

def max_iterations
  @max_iterations
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2733
2734
2735
2736
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2733

def update!(**args)
  @max_iterations = args[:max_iterations] if args.key?(:max_iterations)
  @convergence_threshold = args[:convergence_threshold] if args.key?(:convergence_threshold)
end