/*
 Copyright (C) 2001, 2002, 2003 Sadruddin Rejeb

 This file is part of QuantLib, a free-software/open-source library
 for financial quantitative analysts and developers - http://quantlib.org/

 QuantLib is free software: you can redistribute it and/or modify it under the
 terms of the QuantLib license.  You should have received a copy of the
 license along with this program; if not, please email ferdinando@ametrano.net
 The license is also available online at http://quantlib.org/html/license.html

 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.  See the license for more details.
*/
/*! \file lattice.hpp
    \brief Lattice method class

    \fullpath
    ql/Lattices/%lattice.hpp
*/

// $Id: lattice.hpp,v 1.2.10.1 2002/12/31 18:40:36 nando Exp $

#ifndef quantlib_lattices_lattice_h
#define quantlib_lattices_lattice_h

#include <ql/numericalmethod.hpp>

namespace QuantLib {

    namespace Lattices {

        //! Lattice-method base class
        /*! This class defines a lattice method that is able to rollback (with
            discount) a discretized asset object. It will usually be based on
            one or more trees.
        */
        class Lattice : public NumericalMethod {
          public:
            Lattice(const TimeGrid& timeGrid, Size n)
            : NumericalMethod(timeGrid), n_(n) {
                QL_REQUIRE(n>0, "There is no zeronomial lattice!");
                statePrices_ = std::vector<Array>(1, Array(1, 1.0));
                statePricesLimit_ = 0;
            }

            //! Computes the present value of an asset using Arrow-Debrew prices
            double presentValue(const Handle<DiscretizedAsset>& asset);

            //! Initialize a DiscretizedAsset object.
            void initialize(const Handle<DiscretizedAsset>& asset,
                            Time t) const;

            //! Roll-back a DiscretizedAsset object until a certain time.
            void rollback(const Handle<DiscretizedAsset>& asset,
                          Time to) const;

            virtual Size size(Size i) const = 0;

            //! Discount factor at time t_i and node indexed by index.
            virtual DiscountFactor discount(Size i, Size index) const = 0;

            const Array& statePrices(Size i);

          protected:
            void computeStatePrices(Size until);

            virtual void stepback(Size i, 
                                  const Array& values, 
                                  Array& newValues) const;

            //! Tree properties
            virtual Size descendant(Size i, Size index, Size branch) const = 0;
            virtual double probability(Size i, 
                                       Size index, 
                                       Size branch) const = 0;


            // Arrow-Debrew state prices
            std::vector<Array> statePrices_;

          private:
            Size n_;
            Size statePricesLimit_;
        };

    }

}

#endif
