attack_prediction.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2007 - 2016 by David White <[email protected]>
   Part of the Battle for Wesnoth Project http://www.wesnoth.org/

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 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.

   See the COPYING file for more details.
*/

/** @file */

#ifndef ATTACK_PREDICTION_H_INCLUDED
#define ATTACK_PREDICTION_H_INCLUDED

#include "global.hpp"

#include <vector>

#include <cstring>

struct battle_context_unit_stats;

// This encapsulates all we need to know for this combat.
/** All combat-related info. */
struct combatant
{
    /** Construct a combatant. */
    combatant(const battle_context_unit_stats &u, const combatant *prev = nullptr);

    /** Copy constructor */
    combatant(const combatant &that, const battle_context_unit_stats &u);

    /** Simulate a fight!  Can be called multiple times for cumulative calculations. */
    void fight(combatant &opponent, bool levelup_considered=true);

    /** Resulting probability distribution (might be not as large as max_hp) */
    std::vector<double> hp_dist;

    /** Resulting chance we were not hit by this opponent (important if it poisons) */
    double untouched;

    /** Resulting chance we are poisoned. */
    double poisoned;

    /** Resulting chance we are slowed. */
    double slowed;

    /** What's the average hp (weighted average of hp_dist). */
    double average_hp(unsigned int healing = 0) const;

#if defined(BENCHMARK) || defined(CHECK)
    // Functions used in the stand-alone version of attack_prediction.cpp
    void print(const char label[], unsigned int battle, unsigned int fighter) const;
    void reset();
#endif

private:
    combatant(const combatant &that);
    combatant& operator=(const combatant &);

    struct combat_slice;
    /** Split the combat by number of attacks per combatant (for swarm). */
    std::vector<combat_slice> split_summary() const;

    const battle_context_unit_stats &u_;

    /** Summary of matrix used to calculate last battle (unslowed & slowed).
     *  Invariant: summary[1].size() == summary[0].size() or summary[1].empty() */
    std::vector<double> summary[2];
};

#endif