File: island.rst

package info (click to toggle)
pagmo 2.19.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 85,228 kB
  • sloc: cpp: 1,753,592; makefile: 223; sh: 121; python: 46
file content (35 lines) | stat: -rw-r--r-- 779 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Island
======

*#include <pagmo/island.hpp>*

.. doxygenclass:: pagmo::island
   :members:

Functions
---------

.. cpp:namespace-push:: pagmo

.. cpp:function:: std::ostream &operator<<(std::ostream &os, const island &isl)

   Stream operator for :cpp:class:`pagmo::island`.

   This operator will stream to *os* a human-readable representation of *isl*.

   It is safe to call this method while the island is evolving.

   :param os: the target stream.
   :param isl: the input island.

   :return: a reference to *os*.

   :exception unspecified: any exception thrown by the stream operators of fundamental types or by
      the public interface of :cpp:class:`pagmo::island` and of all its members.

.. cpp:namespace-pop::

Types
-----

.. doxygenenum:: pagmo::evolve_status