mrffl_var_sets.f90

Go to the documentation of this file.

! -*- Mode:F90; Coding:us-ascii-unix; fill-column:129 -*-
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!.H.S.!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!.H.E.!!
!>
!! @file      mrffl_var_sets.f90
!! @author    Mitch Richling http://www.mitchr.me/
!! @date      2025-01-02
!! @brief     Constants to to identify TVM variables.@EOL
!! @keywords  finance fortran monte carlo inflation cashflow time value of money tvm percentages taxes stock market
!! @std       F2023
!! @see       https://github.com/richmit/FortranFinance
!! @copyright
!!  @parblock
!!  Copyright (c) 2025, Mitchell Jay Richling <http://www.mitchr.me/> All rights reserved.
!!
!!  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
!!  conditions are met:
!!
!!  1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following
!!     disclaimer.
!!
!!  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following
!!     disclaimer in the documentation and/or other materials provided with the distribution.
!!
!!  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
!!     derived from this software without specific prior written permission.
!!
!!  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
!!  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
!!  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
!!  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
!!  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
!!  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
!!  OF THE POSSIBILITY OF SUCH DAMAGE.
!!  @endparblock
!!
 
!----------------------------------------------------------------------------------------------------------------------------------
!> Constants to to identify TVM variables.
module mrffl_var_sets
  use mrffl_config, only: ik=>mrfflik
  implicit none
  private
 
  integer(kind=ik), parameter, public :: var_none = 0       !< No variables in set
  integer(kind=ik), parameter, public :: var_a    = 1       !< First annuity payment
  integer(kind=ik), parameter, public :: var_p    = 2       !< Principal
  integer(kind=ik), parameter, public :: var_i    = 4       !< Interest/rate (First rate for geometric annuity)
  integer(kind=ik), parameter, public :: var_g    = 8       !< Second Interest/rate (for geometric annuity)
  integer(kind=ik), parameter, public :: var_n    = 16      !< Number of periods
  integer(kind=ik), parameter, public :: var_pv   = 32      !< Present value
  integer(kind=ik), parameter, public :: var_fv   = 64      !< Future value
  integer(kind=ik), parameter, public :: var_d    = 128     !< Delayed start
  integer(kind=ik), parameter, public :: var_e    = 256     !< Early end for annuities
  integer(kind=ik), parameter, public :: var_q    = 512     !< Growth rate for arithmatic annuities
  integer(kind=ik), parameter, public :: var_pmt  = 1024    !< Currently this is only used by the tvm12 module
 
end module mrffl_var_sets