stock.h

Go to the documentation of this file.

/// @file stock.h
/// Declaration of the Stock class.
/*
This program is free software: you can redistribute it and/or modify it under the
terms of the GNU Lesser General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later version.
 
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 GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License along with this
program. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef STOCK_H
#define STOCK_H
 
#include "events.h"
#include "names.h"
 
#include <istream>
#include <list>
#include <map>
#include <string>
#include <vector>
 
/** @brief Initial stock count */
const int initial_stock_count = 20;
 
/**
 * The upper limit of the stock price.
 * @see Stock::next_round for the "stock split" event.
 */
const float STOCK_PRICE_LIMIT = 1000.0f;
 
/**
 * @class Stock stock.h "stock.h"
 * @brief A class that represents a stock object in the game.
 * The stock has a name, price, quantity, category, money spent, events, attributes, and
 * history. The stock can be purchased, sold, and updated.
 * @note Example usage:
 * @code {.cpp}
 * // Create a stock object. The constructor will initialize the stock automatically.
 * Stock stock;
 * // Purchase a stock.
 * float balance = 1000; stock.purchase(balance, 1, 0.01);
 * // Sell a stock.
 * stock.sell(balance, 1, 0.01);
 * // What is the name of the stock?
 * std::string name = stock.get_name();
 * // Get the upper limit of the percentage change of the stock price:
 * float upper_limit = stock.get_total_attribute(stock_modifiers::upper_limit);
 * @endcode
 */
class Stock {
    public:
        /** @brief Constructor of class Stock */
        Stock(void);
 
        /**
         * @brief Save the stock from a file.
         * @param playerName The name of the player.
         * @param i The index of the stock.
         */
        void save(const std::string & playerName, int i);
 
        /**
         * @brief Load the stock from a file.
         * @param playerName The name of the player.
         * @param i The index of the stock.
         */
        void load(const std::string & playerName, int i);
 
        /**
         * Purchase a given number of stocks.
         * @param balance The balance ($) of the player. Pass-by-reference.
         * @param amount The number of stocks to purchase.
         * @param trading_fees_percent The trading fees percentage we charge the player.
         * @return Successful: Total cost of the purchase.
         *         Failed: -1 if the player does not have enough balance to buy the
         * stock.
         */
        float purchase(
            float & balance, unsigned int amount, float trading_fees_percent);
 
        /**
         * @brief Sell a given number of stocks.
         * @param balance The balance ($) of the player. Pass-by-reference.
         * @param amount The number of stocks to sell.
         * @param trading_fees_percent The trading fees percentage we charge the player.
         * @return Successful: Amount of money the player receive.
         *         Failed: -1 if the player does not have enough stocks to sell.
         */
        float sell(float & balance, unsigned int amount, float trading_fees_percent);
 
        /**
         * @param balance The balance of the player.
         * @param trading_fees_percent The trading fees percentage we charge the player.
         * @return Number of stocks that the player can afford with the balance.
         */
        unsigned int num_stocks_affordable(
            float balance, float trading_fees_percent) const;
 
        /**
         * @brief Return the name of the category the stock belongs to.
         * @return Name of the category as a string.
         */
        std::string category_name(void) const;
 
        /**
         * @brief Return the change of stock price using the most recent price and the
         * current price
         * @return change in stock price.
         */
        float delta_price(void);
 
        /** @brief Return the percentage of change of stock price.
         * @return Percentage of change in stock price. E.g. 0.05 means 5% increase in
         * price.
         */
        float delta_price_percentage(void);
 
        /**
         * @brief Get the total change of attribute of the stock due to events only.
         * Getter function. \n Example usage: @code {.cpp}
         * stock.get_base_attribute(stock_modifiers::standard_deviation);
         * @endcode
         * @param attribute The attribute to get.
         * @return Total change of attribute due to Stock_event. Does not include the
         * base value.
         */
        float get_event_attribute(stock_modifiers attribute);
 
        /**
         * @brief Call this when the game proceed to next round.
         */
        void next_round(void);
 
        /** @brief Add an event to the stock.
         * @param event The event to be added. See events.h for more information about
         * the class Stock_Event.
         */
        void add_event(const Stock_event & event);
 
        /**
         * @brief Get the stock price of recent rounds.
         * @param rounds The number of rounds to look back. 5 means the last 5 rounds.
         * @return A vector of stock prices.
         *         If the number of rounds is greater than the history size, return the
         * whole history. Otherwise, return the most recent rounds. If the history is
         * empty, return an empty vector.
         */
        std::vector<float> return_most_recent_history(unsigned int rounds);
 
        /**
         * @brief Get the name of the stock. Getter function.
         * @return Name of the stock.
         */
        std::string get_name(void) { return name; }
 
        /**
         * @brief Get the price of the stock. Getter function.
         * @return Price of the stock as float.
         */
        float get_price(void) { return price; }
 
        /**
         * @brief Get the category of the stock. Getter function.
         * @return Category of the stock as unsigned int.
         */
        unsigned int get_category(void) { return category; }
 
        /**
         * @brief Get the quantity of the stock. Getter function.
         * @return Stock.quantity as unsigned int.
         */
        unsigned int get_quantity(void) { return quantity; }
 
        /**
         * @brief Get the initial price of the stock. Getter function.
         * @return Initial price of the stock as float.
         */
        float get_initial_price(void) { return history[0]; }
 
        /**
         * @brief Get the base value of stock_attributes of the stock. Getter function.
         * @param attribute The attribute to get. E.g. standard_deviation, mean,
         * lower_limit, upper_limit
         * @return Base value of stock_attributes as float.
         */
        float get_base_attribute(stock_modifiers attribute) {
            return attributes[attribute];
        }
 
        /**
         * @brief Get size of the history.
         * @return Size of the history as unsigned int.
         */
        unsigned int get_history_size(void) { return history.size(); }
 
        /**
         * @brief Change the mean of the stock by delta_mean. Setter function.
         * @param delta_mean The change in mean.
         */
        void change_mean(float delta_mean) { attributes[mean] += delta_mean; }
 
        /**
         * @brief Return all the events that will apply to this stock specifically.
         * Getter function.
         * @return A list of Stock_event.
         */
        std::list<Stock_event> get_events(void) { return events; }
 
        /**
         * @brief Get the event ids of all the events that will apply to this stock
         * specifically. Getter function.
         * @return A vector of unsigned int.
         */
        std::vector<unsigned int> get_event_ids(void);
 
        /**
         * @brief Get the split count of the stock. Getter function.
         * @return Stock.split_count as unsigned int.
         */
        unsigned int get_split_count(void) { return split_count; }
 
        /**
         * @brief Check if we can add the event to the stock.
         * @note
         * A event can be added if the event is not mutually exclusive with any of the
         * existing events.
         * @param event The event to be added.
         * @return True if the event can be added. False otherwise.
         */
        bool can_add_event(const Stock_event & event);
 
        /**
         * @brief Sums up get_base_attribute() and get_event_attribute().
         * @param attribute The attribute to get.
         * @return Total value of the attribute. `float` type.
         */
        float get_total_attribute(stock_modifiers attribute);
 
        /**
         * @brief Calculate the total value of the stocks the player is holding.
         * @param trading_fees_percent The trading fees percentage we charge the player.
         * Set to 0 if you want to exclude trading fees from calculation.
         * @return The total value of the stocks.
         */
        float calculateStockValue(const float & trading_fees_percent) const;
 
        /**
         * @brief Calculate the amount of money player lost due to trading fees.
         * @param trading_fees_percent The trading fees percentage we charge the player.
         * @return The amount of money player lost due to trading fees.
         */
        float calculateTradingFeesLost(const float & trading_fees_percent) const;
 
        /**
         * @brief Set up a getStockSplitEvent() with proper values.
         */
        Stock_event setup_STOCK_SPLIT_EVENT(void);
 
        friend std::ostream & operator<<(std::ostream & fout, const Stock & stock);
 
        friend std::istream & operator>>(std::istream & fin, Stock & stock);
 
    private:
        /** @brief Name of the stock that we assigned to it. */
        std::string name;
 
        /** @brief Current price of the stock. */
        float price;
 
        /** @brief Number of stocks the player has purchased. */
        unsigned int quantity;
 
        /** @brief Use numbers to represent the category of the stock.
         * @note The range of the numbers should be `[0, category_list_size - 1]`.
         * @ref category_list_size
         */
        unsigned int category;
 
        /** @brief Stores all the events that will apply to this stock specifically. */
        std::list<Stock_event> events;
 
        /** @brief Stores the initial value of the stock_modifiers (e.g. standard
         * deviation, mean and limits). */
        std::map<stock_modifiers, float> attributes;
 
        /** @brief Contains the stock price history. First element (index 0) is the
         * oldest. */
        std::vector<float> history;
 
        /** @brief Contains the spliting count of a stock */
        unsigned int split_count;
 
        /** @brief Update the history array with the current price */
        void update_history(void);
 
        /** @brief Remove obselete events from the list `events` that durations are
         * less than/equal to 0 (In other words, expired).
         * For internal use after the `Stock::next_round` function is called.
         */
        void remove_obselete_event(void);
};
 
enum SortingMethods {
    by_name,
    by_price,
    by_category,
    by_quantity,
    by_upper_limit,
    by_lower_limit,
    by_mean,
    by_sd
};
 
enum SortingDirections { ascending, descending };
 
/**
 * @brief Sorts the stocks.
 * @param stocks_list A vector of stocks. Pass by reference to modify the stocks.
 * @param sortMethod Sorting method. Default is by_category.
 * @param sortDirection Sorting direction. True for ascending, false for descending.
 * Default is ascending.
 */
void sortStocksList(std::vector<Stock> & stocks_list,
    SortingMethods sortMethod = by_category,
    SortingDirections sortDirection = ascending);
 
#endif