GitHub build 1609

2.3-dev/api_developer/classwrench_1_1_amdahl_parallel_model.html

@@ -252,10 +252,21 @@
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4NK6wrench19AmdahlParallelModel8getAlphaEv">
 <span id="_CPPv3NK6wrench19AmdahlParallelModel8getAlphaEv"></span><span id="_CPPv2NK6wrench19AmdahlParallelModel8getAlphaEv"></span><span id="wrench::AmdahlParallelModel::getAlphaC"></span><span class="target" id="classwrench_1_1_amdahl_parallel_model_1a2341c58cd0f2123312cd520c511f5f9d"></span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getAlpha</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK6wrench19AmdahlParallelModel8getAlphaEv" title="Permalink to this definition"></a><br /></dt>
-<dd><p>Get the Amdahl Law’s alpha parameter. </p>
+<dd><p>Get the Amdahl Law’s alpha parameter, i.e., the fraction of the sequential execution time that is parallelizable. </p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>the alpha parameter </p>
+<dd class="field-odd"><p>the alpha parameter (a value between 0.9 and 1.0) </p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N6wrench19AmdahlParallelModel8setAlphaEd">
+<span id="_CPPv3N6wrench19AmdahlParallelModel8setAlphaEd"></span><span id="_CPPv2N6wrench19AmdahlParallelModel8setAlphaEd"></span><span id="wrench::AmdahlParallelModel::setAlpha__double"></span><span class="target" id="classwrench_1_1_amdahl_parallel_model_1ab3591550bc25f2b50976308eb361d5d9"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">setAlpha</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">alpha</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6wrench19AmdahlParallelModel8setAlphaEd" title="Permalink to this definition"></a><br /></dt>
+<dd><p>Set the Amdahl Law’s alpha parameter, i.e., the fraction of the sequential execution time that is parallelizable. </p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>alpha</strong> – the alpha parameter (a value between 0.9 and 1.0) </p>
 </dd>
 </dl>
 </dd></dl>

2.3-dev/api_developer/classwrench_1_1_batch_compute_service_property.html

@@ -275,9 +275,9 @@
 <dd><p>The batch scheduling algorithm. Can be: </p>
 <p><ul class="simple">
 <li><p>If ENABLE_BATSCHED is set to off / not set:<ul>
-<li><p>”fcfs”: First Come First Serve (default)</p></li>
+<li><p>”fcfs”: First Come First Serve, which allocates resources at the core level (i.e., two jobs may run on the same node if that node has enough cores to support both jobs) (default)</p></li>
 <li><p>”conservative_bf”: a home-grown implementation of FCFS with conservative backfilling, which only allocates resources at the node level (i.e., two jobs can never run on the same node even if that node has enough cores to support both jobs)</p></li>
-<li><p>”conservative_bf_core_level”: a home-grown implementation of FCFS with conservative backfilling, which only allocates resources at the core level (i.e., two jobs may run on the same node if that node has enough cores to support both jobs)</p></li>
+<li><p>”conservative_bf_core_level”: a home-grown implementation of FCFS with conservative backfilling, which allocates resources at the core level (i.e., two jobs may run on the same node if that node has enough cores to support both jobs)</p></li>
 </ul>
 </p></li>
 <li><p>If ENABLE_BATSCHED is set to on:<ul>

2.3-dev/api_developer/classwrench_1_1_compound_storage_service.html

@@ -250,9 +250,9 @@
 <div class="breathe-sectiondef docutils container">
 <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
 <dl class="cpp function">
-<dt class="sig sig-object cpp" id="_CPPv4N6wrench22CompoundStorageService22CompoundStorageServiceERKNSt6stringENSt3setINSt10shared_ptrI14StorageServiceEEEE32StorageSelectionStrategyCallback31WRENCH_PROPERTY_COLLECTION_TYPE37WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE">
-<span id="_CPPv3N6wrench22CompoundStorageService22CompoundStorageServiceERKNSt6stringENSt3setINSt10shared_ptrI14StorageServiceEEEE32StorageSelectionStrategyCallback31WRENCH_PROPERTY_COLLECTION_TYPE37WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE"></span><span id="_CPPv2N6wrench22CompoundStorageService22CompoundStorageServiceERKNSt6stringENSt3setINSt10shared_ptrI14StorageServiceEEEE32StorageSelectionStrategyCallback31WRENCH_PROPERTY_COLLECTION_TYPE37WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE"></span><span id="wrench::CompoundStorageService::CompoundStorageService__ssCR.std::set:std::shared_ptr:StorageService::.StorageSelectionStrategyCallback.WRENCH_PROPERTY_COLLECTION_TYPE.WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE"></span><span class="target" id="classwrench_1_1_compound_storage_service_1a08a58eec9112a0742cb4a4eadcd67c31"></span><span class="sig-name descname"><span class="n"><span class="pre">CompoundStorageService</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">hostname</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">set</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="classwrench_1_1_storage_service.html#_CPPv4N6wrench14StorageServiceE" title="wrench::StorageService"><span class="n"><span class="pre">StorageService</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">storage_services</span></span>, <span class="n"><span class="pre">StorageSelectionStrategyCallback</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">storage_selection</span></span>, <span class="n"><span class="pre">WRENCH_PROPERTY_COLLECTION_TYPE</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">property_list</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span>, <span class="n"><span class="pre">WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">messagepayload_list</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6wrench22CompoundStorageService22CompoundStorageServiceERKNSt6stringENSt3setINSt10shared_ptrI14StorageServiceEEEE32StorageSelectionStrategyCallback31WRENCH_PROPERTY_COLLECTION_TYPE37WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE" title="Permalink to this definition"></a><br /></dt>
-<dd><p>Constructor for the case where the user provides a callback (StorageSelectionStrategyCallback) which will be used by the <a class="reference internal" href="../api_user/classwrench_1_1_compound_storage_service.html#classwrench_1_1_compound_storage_service"><span class="std std-ref">CompoundStorageService</span></a> any time it receives a file write or file copy request, in order to determine which underlying <a class="reference internal" href="../api_user/classwrench_1_1_storage_service.html#classwrench_1_1_storage_service"><span class="std std-ref">StorageService</span></a> to use for the (potentially) new file in the request. Note that nothing prevents the user from also intercepting some actions (see use case for other constructor), but resulting behaviour is undefined. </p>
+<dt class="sig sig-object cpp" id="_CPPv4N6wrench22CompoundStorageService22CompoundStorageServiceERKNSt6stringENSt3setINSt10shared_ptrI14StorageServiceEEEER32StorageSelectionStrategyCallback31WRENCH_PROPERTY_COLLECTION_TYPE37WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE">
+<span id="_CPPv3N6wrench22CompoundStorageService22CompoundStorageServiceERKNSt6stringENSt3setINSt10shared_ptrI14StorageServiceEEEER32StorageSelectionStrategyCallback31WRENCH_PROPERTY_COLLECTION_TYPE37WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE"></span><span id="_CPPv2N6wrench22CompoundStorageService22CompoundStorageServiceERKNSt6stringENSt3setINSt10shared_ptrI14StorageServiceEEEER32StorageSelectionStrategyCallback31WRENCH_PROPERTY_COLLECTION_TYPE37WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE"></span><span id="wrench::CompoundStorageService::CompoundStorageService__ssCR.std::set:std::shared_ptr:StorageService::.StorageSelectionStrategyCallbackR.WRENCH_PROPERTY_COLLECTION_TYPE.WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE"></span><span class="target" id="classwrench_1_1_compound_storage_service_1a7b3fd9886a2aa0223e41c878f52c6d34"></span><span class="sig-name descname"><span class="n"><span class="pre">CompoundStorageService</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">hostname</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">set</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="classwrench_1_1_storage_service.html#_CPPv4N6wrench14StorageServiceE" title="wrench::StorageService"><span class="n"><span class="pre">StorageService</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">storage_services</span></span>, <span class="n"><span class="pre">StorageSelectionStrategyCallback</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">allocate</span></span>, <span class="n"><span class="pre">WRENCH_PROPERTY_COLLECTION_TYPE</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">property_list</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span>, <span class="n"><span class="pre">WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">messagepayload_list</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6wrench22CompoundStorageService22CompoundStorageServiceERKNSt6stringENSt3setINSt10shared_ptrI14StorageServiceEEEER32StorageSelectionStrategyCallback31WRENCH_PROPERTY_COLLECTION_TYPE37WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE" title="Permalink to this definition"></a><br /></dt>
+<dd><p>Constructor. </p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
@@ -843,14 +843,15 @@
 </dd></dl>
 
 <dl class="cpp function">
-<dt class="sig sig-object cpp" id="_CPPv4N6wrench22CompoundStorageService9writeFileEPN7simgrid3s4u7MailboxERKNSt10shared_ptrI12FileLocationEEb">
-<span id="_CPPv3N6wrench22CompoundStorageService9writeFileEPN7simgrid3s4u7MailboxERKNSt10shared_ptrI12FileLocationEEb"></span><span id="_CPPv2N6wrench22CompoundStorageService9writeFileEPN7simgrid3s4u7MailboxERKNSt10shared_ptrI12FileLocationEEb"></span><span id="wrench::CompoundStorageService::writeFile__simgrid::s4u::MailboxP.std::shared_ptr:FileLocation:CR.b"></span><span class="target" id="classwrench_1_1_compound_storage_service_1a392155d5226f2edec47ef378546a46e8"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">writeFile</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">simgrid</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">s4u</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Mailbox</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">answer_mailbox</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="classwrench_1_1_file_location.html#_CPPv4N6wrench12FileLocationE" title="wrench::FileLocation"><span class="n"><span class="pre">FileLocation</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">location</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">wait_for_answer</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N6wrench22CompoundStorageService9writeFileEPN7simgrid3s4u7MailboxERKNSt10shared_ptrI12FileLocationEEb" title="Permalink to this definition"></a><br /></dt>
+<dt class="sig sig-object cpp" id="_CPPv4N6wrench22CompoundStorageService9writeFileEPN7simgrid3s4u7MailboxERKNSt10shared_ptrI12FileLocationEEdb">
+<span id="_CPPv3N6wrench22CompoundStorageService9writeFileEPN7simgrid3s4u7MailboxERKNSt10shared_ptrI12FileLocationEEdb"></span><span id="_CPPv2N6wrench22CompoundStorageService9writeFileEPN7simgrid3s4u7MailboxERKNSt10shared_ptrI12FileLocationEEdb"></span><span id="wrench::CompoundStorageService::writeFile__simgrid::s4u::MailboxP.std::shared_ptr:FileLocation:CR.double.b"></span><span class="target" id="classwrench_1_1_compound_storage_service_1a0f7caae5f4066b1ae2eeba86accc1add"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">writeFile</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">simgrid</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">s4u</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Mailbox</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">answer_mailbox</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="classwrench_1_1_file_location.html#_CPPv4N6wrench12FileLocationE" title="wrench::FileLocation"><span class="n"><span class="pre">FileLocation</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">location</span></span>, <span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">num_bytes_to_write</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">wait_for_answer</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N6wrench22CompoundStorageService9writeFileEPN7simgrid3s4u7MailboxERKNSt10shared_ptrI12FileLocationEEdb" title="Permalink to this definition"></a><br /></dt>
 <dd><p>Synchronously write a file to the storage service. </p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>answer_mailbox</strong> – the answer mailbox to which the reply from the server should be sent </p></li>
 <li><p><strong>location</strong> – the location </p></li>
+<li><p><strong>num_bytes_to_write</strong> – number of bytes to write to the file </p></li>
 <li><p><strong>wait_for_answer</strong> – whether to wait for the answer</p></li>
 </ul>
 </dd>