FedFundFutures.java

package org.drip.sample.forwardratefutures;

import java.util.Map;

import org.drip.analytics.date.*;
import org.drip.param.creator.MarketParamsBuilder;
import org.drip.param.market.CurveSurfaceQuoteContainer;
import org.drip.param.valuation.ValuationParams;
import org.drip.product.creator.SingleStreamComponentBuilder;
import org.drip.product.rates.SingleStreamComponent;
import org.drip.sample.forward.OvernightIndexCurve;
import org.drip.service.env.EnvManager;
import org.drip.state.discount.MergedDiscountForwardCurve;
import org.drip.state.identifier.OvernightLabel;

/*
 * -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 */

/*!
 * Copyright (C) 2019 Lakshmi Krishnamurthy
 * Copyright (C) 2018 Lakshmi Krishnamurthy
 * Copyright (C) 2017 Lakshmi Krishnamurthy
 * Copyright (C) 2016 Lakshmi Krishnamurthy
 * Copyright (C) 2015 Lakshmi Krishnamurthy
 * Copyright (C) 2014 Lakshmi Krishnamurthy
 * 
 *  This file is part of DROP, an open-source library targeting risk, transaction costs, exposure, margin
 *      calculations, valuation adjustment, and portfolio construction within and across fixed income,
 *      credit, commodity, equity, FX, and structured products.
 *  
 *      https://lakshmidrip.github.io/DROP/
 *  
 *  DROP is composed of three modules:
 *  
 *  - DROP Analytics Core - https://lakshmidrip.github.io/DROP-Analytics-Core/
 *  - DROP Portfolio Core - https://lakshmidrip.github.io/DROP-Portfolio-Core/
 *  - DROP Numerical Core - https://lakshmidrip.github.io/DROP-Numerical-Core/
 * 
 *  DROP Analytics Core implements libraries for the following:
 *  - Fixed Income Analytics
 *  - Asset Backed Analytics
 *  - XVA Analytics
 *  - Exposure and Margin Analytics
 * 
 *  DROP Portfolio Core implements libraries for the following:
 *  - Asset Allocation Analytics
 *  - Transaction Cost Analytics
 * 
 *  DROP Numerical Core implements libraries for the following:
 *  - Statistical Learning
 *  - Numerical Optimizer
 *  - Spline Builder
 *  - Algorithm Support
 * 
 *  Documentation for DROP is Spread Over:
 * 
 *  - Main                     => https://lakshmidrip.github.io/DROP/
 *  - Wiki                     => https://github.com/lakshmiDRIP/DROP/wiki
 *  - GitHub                   => https://github.com/lakshmiDRIP/DROP
 *  - Repo Layout Taxonomy     => https://github.com/lakshmiDRIP/DROP/blob/master/Taxonomy.md
 *  - Javadoc                  => https://lakshmidrip.github.io/DROP/Javadoc/index.html
 *  - Technical Specifications => https://github.com/lakshmiDRIP/DROP/tree/master/Docs/Internal
 *  - Release Versions         => https://lakshmidrip.github.io/DROP/version.html
 *  - Community Credits        => https://lakshmidrip.github.io/DROP/credits.html
 *  - Issues Catalog           => https://github.com/lakshmiDRIP/DROP/issues
 *  - JUnit                    => https://lakshmidrip.github.io/DROP/junit/index.html
 *  - Jacoco                   => https://lakshmidrip.github.io/DROP/jacoco/index.html
 * 
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *      you may not use this file except in compliance with the License.
 *   
 *  You may obtain a copy of the License at
 *      http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *      distributed under the License is distributed on an "AS IS" BASIS,
 *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  
 *  See the License for the specific language governing permissions and
 *      limitations under the License.
 */

/**
 * <i>FedFundFutures</i> contains the demonstration of the construction and the Valuation of the Fed Fund
 * Futures Contract.
 *  
 * <br><br>
 *  <ul>
 *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/AnalyticsCore.md">Analytics Core Module</a></li>
 *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/FixedIncomeAnalyticsLibrary.md">Fixed Income Analytics Library</a></li>
 *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/README.md">Sample</a></li>
 *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/forwardratefutures/README.md">Forward Rate Futures Analytics</a></li>
 *  </ul>
 * <br><br>
 * 
 * @author Lakshmi Krishnamurthy
 */

public class FedFundFutures {
    public static final void main (
        final String[] astrArgs)
        throws Exception
    {
        /*
         * Initialize the Credit Analytics Library
         */

        EnvManager.InitEnv ("");

        String strCurrency = "USD";

        JulianDate dtToday = DateUtil.Today();

        MergedDiscountForwardCurve dcOIS = OvernightIndexCurve.MakeDC (
            dtToday,
            strCurrency
        );

        SingleStreamComponent fedFundFutures = SingleStreamComponentBuilder.Deposit (
            dtToday,
            dtToday.addTenor ("1M"),
            OvernightLabel.Create (
                strCurrency
            )
        );

        CurveSurfaceQuoteContainer mktParams = MarketParamsBuilder.Create (
            dcOIS,
            null,
            null,
            null,
            null,
            null,
            null,
            null
        );

        ValuationParams valParams = new ValuationParams (
            dtToday,
            dtToday,
            strCurrency
        );

        Map<String, Double> mapFedFundFuturesOutput = fedFundFutures.value (
            valParams,
            null,
            mktParams,
            null
        );

        for (Map.Entry<String, Double> me : mapFedFundFuturesOutput.entrySet())
            System.out.println ("\t" + me.getKey() + " => " + me.getValue());

        EnvManager.TerminateEnv();
    }
}