X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c04075c49b6bc68df4f37240b4ac53e7a108abaa..a707ad979be7c88d7581f403661c67598d320d55:/include/simgrid/s4u/Host.hpp diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index b59ec85d10..f495f03999 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2022. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -152,13 +152,19 @@ public: /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account. * * The amount of flops per second available for computing depends on several things: - * - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the - * computing speed you would get at another pstate) - * - If you declared an external load (with @ref set_speed_profile()), you must multiply the - * result of get_speed() by get_available_speed() to retrieve what a new computation would get. + * - The current pstate determines the maximal peak computing speed (use + * @verbatim embed:rst:inline :cpp:func:`get_pstate_speed() ` @endverbatim + * to retrieve the computing speed you would get at another pstate) + * - If you declared an external load (with + * @verbatim embed:rst:inline :cpp:func:`set_speed_profile() ` + * @endverbatim ), you must multiply the result of + * @verbatim embed:rst:inline :cpp:func:`get_speed() ` @endverbatim by + * @verbatim embed:rst:inline :cpp:func:`get_available_speed() ` + * @endverbatim to retrieve what a new computation would get. * * The remaining speed is then shared between the executions located on this host. - * You can retrieve the amount of tasks currently running on this host with @ref get_load(). + * You can retrieve the amount of tasks currently running on this host with + * @verbatim embed:rst:inline :cpp:func:`get_load() ` @endverbatim . * * The host may have multiple cores, and your executions may be able to use more than a single core. * @@ -167,7 +173,8 @@ public: double get_speed() const; /** @brief Get the available speed ratio, between 0 and 1. * - * This accounts for external load (see @ref set_speed_profile()). + * This accounts for external load (see + * @verbatim embed:rst:inline :cpp:func:`set_speed_profile() ` @endverbatim ). */ double get_available_speed() const; @@ -222,7 +229,7 @@ public: VirtualMachine* create_vm(const std::string& name, int core_amount, size_t ramsize); void route_to(const Host* dest, std::vector& links, double* latency) const; - void route_to(const Host* dest, std::vector& links, double* latency) const; + void route_to(const Host* dest, std::vector& links, double* latency) const; /** * @brief Seal this host @@ -230,11 +237,6 @@ public: */ Host* seal(); -#ifndef DOXYGEN - XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto()") void sendto(Host* dest, double byte_amount); - XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto_async()") CommPtr sendto_async(Host* dest, double byte_amount); -#endif - NetZone* get_englobing_zone() const; /** Block the calling actor on an execution located on the called host *