com.barrybecker4.simulation.stock.StockSampleOptions.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bb4-stock Show documentation

bb4-simulation java code.

The newest version!

 // Copyright by Barry G. Becker, 2016-2017. Licensed under MIT License: http://www.opensource.org/licenses/MIT
package com.barrybecker4.simulation.stock

/**
  * Defaults for stock app.
  * Options for a sample of stocks being held for some number of years.
  *
  * @author Barry Becker
  */
object StockSampleOptions {
  val DEFAULT_NUM_STOCKS = 1
  val DEFAULT_NUM_TIME_PERIODS = 100
  val DEFAULT_PERCENT_INCREASE = 0.6
  val DEFAULT_PERCENT_DECREASE = 0.4
  val DEFAULT_STARTING_VALUE = 1000.0
  val DEFAULT_X_RESOLUTION = 2
  val DEFAULT_USE_LOG_SCALE = true
  val DEFAULT_USE_RANDOM_CHANGE = false
}

class StockSampleOptions {
  var numStocks: Int = StockSampleOptions.DEFAULT_NUM_STOCKS
  var numTimePeriods: Int = StockSampleOptions.DEFAULT_NUM_TIME_PERIODS
  var percentIncrease: Double = StockSampleOptions.DEFAULT_PERCENT_INCREASE
  var percentDecrease: Double = StockSampleOptions.DEFAULT_PERCENT_DECREASE
  var startingValue: Double = StockSampleOptions.DEFAULT_STARTING_VALUE
  var xResolution: Int = StockSampleOptions.DEFAULT_X_RESOLUTION
  var useLogScale: Boolean = StockSampleOptions.DEFAULT_USE_LOG_SCALE
  var useRandomChange: Boolean = StockSampleOptions.DEFAULT_USE_RANDOM_CHANGE

  /**
    * This theoretical maximum is something that could occur but rarely
    * ever would by chance. One use of it is used to set an upper limit on the axis.
    * @return upper limit on sample value.
    */
  def getTheoreticalMaximum: Double = startingValue * Math.pow(1.0 + percentIncrease, numTimePeriods)
}