Class: ProtonApi::MonteCarloRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/models/monte_carlo_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MonteCarloRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 141

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'min_bal')
    if (value = attributes[:'min_bal']).is_a?(Array)
      self.min_bal = value
    end
  end

  if attributes.has_key?(:'max_bal')
    if (value = attributes[:'max_bal']).is_a?(Array)
      self.max_bal = value
    end
  end

  if attributes.has_key?(:'p')
    if (value = attributes[:'p']).is_a?(Array)
      self.p = value
    end
  end

  if attributes.has_key?(:'allocation_id')
    self.allocation_id = attributes[:'allocation_id']
  end

  if attributes.has_key?(:'init_bal')
    self.init_bal = attributes[:'init_bal']
  end

  if attributes.has_key?(:'max_sample')
    if (value = attributes[:'max_sample']).is_a?(Array)
      self.max_sample = value
    end
  end

  if attributes.has_key?(:'model_id')
    self.model_id = attributes[:'model_id']
  end

  if attributes.has_key?(:'cf')
    if (value = attributes[:'cf']).is_a?(Array)
      self.cf = value
    end
  end

  if attributes.has_key?(:'create_log')
    self.create_log = attributes[:'create_log']
  else
    self.create_log = false
  end

  if attributes.has_key?(:'aggregation_account_id')
    self. = attributes[:'aggregation_account_id']
  end

  if attributes.has_key?(:'n')
    self.n = attributes[:'n']
  else
    self.n = 1000
  end

  if attributes.has_key?(:'remove_outliers')
    self.remove_outliers = attributes[:'remove_outliers']
  else
    self.remove_outliers = false
  end

  if attributes.has_key?(:'sigma')
    if (value = attributes[:'sigma']).is_a?(Array)
      self.sigma = value
    end
  end

  if attributes.has_key?(:'mu')
    if (value = attributes[:'mu']).is_a?(Array)
      self.mu = value
    end
  end

  if attributes.has_key?(:'portfolio_id')
    self.portfolio_id = attributes[:'portfolio_id']
  end

  if attributes.has_key?(:'result_type')
    self.result_type = attributes[:'result_type']
  else
    self.result_type = 'raw'
  end

  if attributes.has_key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.has_key?(:'use_proxy_data')
    self.use_proxy_data = attributes[:'use_proxy_data']
  else
    self.use_proxy_data = false
  end

  if attributes.has_key?(:'market_data_source')
    self.market_data_source = attributes[:'market_data_source']
  else
    self.market_data_source = 'nucleus'
  end

  if attributes.has_key?(:'ret_mod')
    if (value = attributes[:'ret_mod']).is_a?(Array)
      self.ret_mod = value
    end
  end

  if attributes.has_key?(:'frequency_interval')
    self.frequency_interval = attributes[:'frequency_interval']
  else
    self.frequency_interval = 'year'
  end

  if attributes.has_key?(:'min_sample')
    if (value = attributes[:'min_sample']).is_a?(Array)
      self.min_sample = value
    end
  end
end

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



49
50
51
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 49

def 
  @account_id
end

#aggregation_account_id ⇒ Object

Returns the value of attribute aggregation_account_id.



35
36
37
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 35

def 
  @aggregation_account_id
end

#allocation_id ⇒ Object

Returns the value of attribute allocation_id.



23
24
25
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 23

def allocation_id
  @allocation_id
end

#cf ⇒ Object

Returns the value of attribute cf.



31
32
33
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 31

def cf
  @cf
end

#create_log ⇒ Object

Returns the value of attribute create_log.



33
34
35
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 33

def create_log
  @create_log
end

#frequency_interval ⇒ Object

Returns the value of attribute frequency_interval.



57
58
59
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 57

def frequency_interval
  @frequency_interval
end

#init_bal ⇒ Object

Returns the value of attribute init_bal.



25
26
27
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 25

def init_bal
  @init_bal
end

#market_data_source ⇒ Object

Returns the value of attribute market_data_source.



53
54
55
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 53

def market_data_source
  @market_data_source
end

#max_bal ⇒ Object

Returns the value of attribute max_bal.



19
20
21
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 19

def max_bal
  @max_bal
end

#max_sample ⇒ Object

Returns the value of attribute max_sample.



27
28
29
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 27

def max_sample
  @max_sample
end

#min_bal ⇒ Object

Returns the value of attribute min_bal.



17
18
19
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 17

def min_bal
  @min_bal
end

#min_sample ⇒ Object

Returns the value of attribute min_sample.



59
60
61
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 59

def min_sample
  @min_sample
end

#model_id ⇒ Object

Returns the value of attribute model_id.



29
30
31
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 29

def model_id
  @model_id
end

#mu ⇒ Object

Returns the value of attribute mu.



43
44
45
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 43

def mu
  @mu
end

#n ⇒ Object

Returns the value of attribute n.



37
38
39
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 37

def n
  @n
end

#p ⇒ Object

Returns the value of attribute p.



21
22
23
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 21

def p
  @p
end

#portfolio_id ⇒ Object

Returns the value of attribute portfolio_id.



45
46
47
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 45

def portfolio_id
  @portfolio_id
end

#remove_outliers ⇒ Object

Returns the value of attribute remove_outliers.



39
40
41
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 39

def remove_outliers
  @remove_outliers
end

#result_type ⇒ Object

Returns the value of attribute result_type.



47
48
49
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 47

def result_type
  @result_type
end

#ret_mod ⇒ Object

Returns the value of attribute ret_mod.



55
56
57
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 55

def ret_mod
  @ret_mod
end

#sigma ⇒ Object

Returns the value of attribute sigma.



41
42
43
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 41

def sigma
  @sigma
end

#use_proxy_data ⇒ Object

Returns the value of attribute use_proxy_data.



51
52
53
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 51

def use_proxy_data
  @use_proxy_data
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 84

def self.attribute_map
  {
    :'min_bal' => :'min_bal',
    :'max_bal' => :'max_bal',
    :'p' => :'p',
    :'allocation_id' => :'allocation_id',
    :'init_bal' => :'init_bal',
    :'max_sample' => :'max_sample',
    :'model_id' => :'model_id',
    :'cf' => :'cf',
    :'create_log' => :'create_log',
    :'aggregation_account_id' => :'aggregation_account_id',
    :'n' => :'n',
    :'remove_outliers' => :'remove_outliers',
    :'sigma' => :'sigma',
    :'mu' => :'mu',
    :'portfolio_id' => :'portfolio_id',
    :'result_type' => :'result_type',
    :'account_id' => :'account_id',
    :'use_proxy_data' => :'use_proxy_data',
    :'market_data_source' => :'market_data_source',
    :'ret_mod' => :'ret_mod',
    :'frequency_interval' => :'frequency_interval',
    :'min_sample' => :'min_sample'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 112

def self.swagger_types
  {
    :'min_bal' => :'Array<Float>',
    :'max_bal' => :'Array<Float>',
    :'p' => :'Array<Float>',
    :'allocation_id' => :'String',
    :'init_bal' => :'Float',
    :'max_sample' => :'Array<Float>',
    :'model_id' => :'String',
    :'cf' => :'Array<Array<Float>>',
    :'create_log' => :'BOOLEAN',
    :'aggregation_account_id' => :'String',
    :'n' => :'Integer',
    :'remove_outliers' => :'BOOLEAN',
    :'sigma' => :'Array<Float>',
    :'mu' => :'Array<Float>',
    :'portfolio_id' => :'String',
    :'result_type' => :'String',
    :'account_id' => :'String',
    :'use_proxy_data' => :'BOOLEAN',
    :'market_data_source' => :'String',
    :'ret_mod' => :'Array<Float>',
    :'frequency_interval' => :'String',
    :'min_sample' => :'Array<Float>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 363

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      min_bal == o.min_bal &&
      max_bal == o.max_bal &&
      p == o.p &&
      allocation_id == o.allocation_id &&
      init_bal == o.init_bal &&
      max_sample == o.max_sample &&
      model_id == o.model_id &&
      cf == o.cf &&
      create_log == o.create_log &&
       == o. &&
      n == o.n &&
      remove_outliers == o.remove_outliers &&
      sigma == o.sigma &&
      mu == o.mu &&
      portfolio_id == o.portfolio_id &&
      result_type == o.result_type &&
       == o. &&
      use_proxy_data == o.use_proxy_data &&
      market_data_source == o.market_data_source &&
      ret_mod == o.ret_mod &&
      frequency_interval == o.frequency_interval &&
      min_sample == o.min_sample
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 425

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    value
  when :Date
    value
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = ProtonApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 489

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 405

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


392
393
394
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 392

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



398
399
400
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 398

def hash
  [min_bal, max_bal, p, allocation_id, init_bal, max_sample, model_id, cf, create_log, , n, remove_outliers, sigma, mu, portfolio_id, result_type, , use_proxy_data, market_data_source, ret_mod, frequency_interval, min_sample].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 270

def list_invalid_properties
  invalid_properties = Array.new
  if !@init_bal.nil? && @init_bal < 0
    invalid_properties.push('invalid value for "init_bal", must be greater than or equal to 0.')
  end

  if @cf.nil?
    invalid_properties.push('invalid value for "cf", cf cannot be nil.')
  end

  if !@n.nil? && @n > 10000
    invalid_properties.push('invalid value for "n", must be smaller than or equal to 10000.')
  end

  if !@n.nil? && @n < 1
    invalid_properties.push('invalid value for "n", must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



470
471
472
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 470

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



476
477
478
479
480
481
482
483
484
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 476

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



464
465
466
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 464

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/proton_api/models/monte_carlo_request.rb', line 293

def valid?
  return false if !@init_bal.nil? && @init_bal < 0
  return false if @cf.nil?
  return false if !@n.nil? && @n > 10000
  return false if !@n.nil? && @n < 1
  result_type_validator = EnumAttributeValidator.new('String', ['raw', 'custom', 'median', 'mean', 'tens'])
  return false unless result_type_validator.valid?(@result_type)
  market_data_source_validator = EnumAttributeValidator.new('String', ['nucleus', 'integration'])
  return false unless market_data_source_validator.valid?(@market_data_source)
  frequency_interval_validator = EnumAttributeValidator.new('String', ['year', 'six_months', 'quarter', 'month', 'two_weeks', 'week', 'day'])
  return false unless frequency_interval_validator.valid?(@frequency_interval)
  true
end