Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid

[simgrid.git] / src / bindings / java / org / simgrid / msg / Task.java

diff --git a/src/bindings/java/org/simgrid/msg/Task.java b/src/bindings/java/org/simgrid/msg/Task.java
index 64cf042..5007cc4 100644 (file)
--- a/src/bindings/java/org/simgrid/msg/Task.java
+++ b/src/bindings/java/org/simgrid/msg/Task.java
@@ -35,7 +35,7 @@ public class Task {
         * * Constructors * *
         * *              * */
        /**
-        * Construct an new task with the specified processing amount and amount
+        * Construct a new task with the specified processing amount and amount
         * of data needed.
         *
         * @param name  Task's name
@@ -53,13 +53,18 @@ public class Task {
                this.messageSize = bytesAmount;
        }
        /**
-        * Construct an new parallel task with the specified processing amount and amount for each host
+        * Construct a new parallel task with the specified processing amount and amount for each host
         * implied.
         *
         * @param name          The name of the parallel task.
         * @param hosts         The list of hosts implied by the parallel task.
-        * @param flopsAmount   The amount of operations to be performed by each host of \a hosts.
-        * @param bytesAmount   A matrix describing the amount of data to exchange between hosts.
+        * @param flopsAmount   The amount of operations to be performed by each host of hosts. 
+        *                      flopsAmount[i] is the total number of operations that have to be 
+        *                      performed on hosts[i].
+        * @param bytesAmount   A matrix describing the amount of data to exchange between hosts. The 
+        *                      length of this array must be hosts.length * hosts.length. It is actually 
+        *                      used as a matrix with the lines being the source and the columns being 
+        *                      the destination of the communications.
         */ 
        public Task(String name, Host[]hosts, double[]flopsAmount, double[]bytesAmount) {
                parallelCreate(name, hosts, flopsAmount, bytesAmount);
@@ -68,7 +73,7 @@ public class Task {
        /**
         * The natively implemented method to create a MSG task.
         *
-        * @param name            The name of th task.
+        * @param name            The name of the task.
         * @param flopsAmount    A value of the processing amount (in flop) needed 
         *                        to process the task. If 0, then it cannot be executed
         *                        with the execute() method. This value has to be >= 0.
@@ -86,7 +91,7 @@ public class Task {
         * The natively implemented method to create a MSG parallel task.
         *
         * @param name                The name of the parallel task.
-        * @param hosts                The list of hosts implied by the parallel task.
+        * @param hosts               The list of hosts implied by the parallel task.
         * @param flopsAmount         The total number of operations that have to be performed
         *                            on the hosts.
         * @param bytesAmount        An array of doubles
@@ -100,7 +105,7 @@ public class Task {
        /* *                   * *
         * * Getters / Setters * *
         * *                   * */
-       /** Gets the name of a task */
+       /** Gets the name of the task */
        public String getName() {
                return name;
        }
@@ -155,8 +160,8 @@ public class Task {
         */
        public native void execute() throws HostFailureException,TaskCancelledException;
 
-       /** Bound a computation to a certain load */
-       public native void setBound(double load); 
+       /** Changes the maximum CPU utilization of a computation task. Unit is flops/s. */
+       public native void setBound(double bound); 
 
        /** Cancels a task. */ 
        public native void cancel();
@@ -353,11 +358,6 @@ public class Task {
         */
        public native static boolean listen(String mailbox);
 
-       /**
-        * Counts the number of tasks waiting to be received on the \a mailbox identified by the specified alia and sended by the specified \a host.
-        */
-       public native static int listenFromHost(String alias, Host host);
-
        /**
         * Class initializer, to initialize various JNI stuff
         */