EcmaScript et ISIS-Fish

L'ecmascript est comme son nom l'indique un langage dit de script, c'est à dire qu'il n'est pas compilé avant son exécution (Pareil que R, VisualBasic...). L'EcmaScript va être utile dans ISIS-Fish à principalement trois niveaux: - pour spécifier des équations (par exemple, équation de croissance, de mortalité naturelle, de migration, de reproduction) - pour modifier les valeurs de certains paramètres sans avoir à modifier la base de données à travers de scripts de présimulations. Ceci est particulièrement intéressant dans le cadre d'analyse de sensibilité - pour coder des règles de gestion.

Si la connaissance de l'EcmaScript n'est pas complètement indispensable à l'utilisation de ISIS-Fish, avoir quelques notions s'avère fort utile.

Les bases de l'EcmaScript

Les commentaires en EcmaScript

Comme pour tout langage de programmation, il est particulièrement intéressant de décrire (documenter) un code afin de le rendre plus compréhensible pour un autre utilisateur ou lors d'une réutilisation postérieure. Le commentaire doit donc être un texte apparaissant dans le code mais non exécuté lors de l'exécution. Un commentaire peut-être ajouté de deux manières en Ecmascript comme détaillé dans l'exemple.

Ex:

var a=2 //tout ce qui figure sur cette ligne après le signe est un commentaire
/*je peux mettre un commentaire
sur plusieurs lignes entre antislash étoile
et étoile antislash*/
var b=3;

Les types primitifs de données – les variables

En Ecmascript, les variables quelque soit leur type se déclarent d'une seule et même façon.

L'instruction:

var NouvelleVariable;

crée une nouvelle variable appelée NouvelleVariable (attention: les majuscules comptent).

Il existe cinq types de données primitives en EcmaScript: undefined, null, Boolean, Number et String, admettent en revanche plusieurs valeurs différentes.

• undefined: variable qui n'a pas encore de valeurs

• null: variable vide ou fonction non gérée

• string: chaîne de caractères

• booléen: true ou false

• numeric: un nombre

L'affectation d'une valeur à une variable se fait avec l'opérateur =.

Opérations sur les variables primitives

Opérations mathématiques et concaténations

Les opérations mathématiques classiques telles que +, -, *, / sont définies sur les variables numériques, ainsi que l'opérateur % qui donne le reste de la division euclidienne

Ex:

var a=2;
var b=5;
a+b; //renvoie 7
a-b; //renvoie -3
b%a //renvoie 1

++ et -- permettent d'incrémenter ou de diminuer d'une unité une variable numérique.

Ex:

var a=2
a++; //a vaut 3
a--; //a vaut 2

+= , -= , /= et *= prend la valeur de gauche y additionne (ou soustrait, ou divise ou multiplie) la valeur de droite et affecte le résultat à la variable de gauche.

Ex:

var a=2;
a+=3; //a vaut 5

Pour les chaînes de caractères, l'opérateur + (+= rajoute à la fin) permet de concaténer plusieurs chaînes.

Opérateurs de comparaisons

Les opérateurs de comparaisons renvoient un booléen si la comparaison est vraie ou fausse. Attention ces opérateurs ne marchent que sur des numeric.

Opérateurs logiques

Et logique

Ou logique

Le contrôle de flux

Les blocs

{//début du bloc
var a=3;
a++;
}// fin du bloc

if, else et else if

if (a==1){
  //bloc si a est égal à 1
  if (b<2){
    b++; //instruction réalisée si en plus b est inférieur à 2
  }
  else{
    b--; //instruction réalisée si en plus b est supérieur ou égal à 2
  }
} //fin du bloc if
else if (a>0 && b>0){
  b++;  //bloc réalisé si a est différent de 1 mais supérieur à 0 et que b est inférieur à 0
  a++;
}
else {
  b--; //bloc réalisé si a est différent de 1, et si a et b ne sont pas strictement positifs
}

switch

switch (Option){ //
  case 1:
    a++;       //ce bloc est réalisé si Option vaut 1
    break;
  case 2:
    b++;
    break;       //ce bloc est réalisé si Option vaut 2
}

Structures de boucles

Boucles for

var a=1;
for (var i=1; i<3; i++){/*le compteur i vaut 1 en début de simulation, on 
                        renouvelle l'opération tant que i<3 et i augmente d'
                        une unité à chaque opération*/
  a++;
} //en sortie a vaut 3

Boucles while

var a=1;
var i=1;
while (i<3){
  a++;
  i++;
} // le résultat est ici exactement le même que dans l'exemple précédent

boucles do...while

var a=1;
var i=1;
do{
  a++;
  i++;
} while(i<3); // attention au ;

La structure de la base de données et les classes d'objet

Les classes d'objets

ISIS et la base de données

var Thon=PopulationFactory.findByName('Thon'); //On récupère la population 
                                               //dont le nom est Thon

• http://isis-fish.labs.libre-entreprise.org/api/isis-fish/version2/index.html (api du simulateur)
• http://isis-fish.labs.libre-entreprise.org/api/codelutin/index.html (api des librairies annexes, essentiellement les dbCollections qui sont des containers)
• http://lutinmatrix.labs.libre-entreprise.org/apidocs/index.html (api des matrices)

• Pour créer un objet d'un certain type (par exemple Population ou MatriceND), on doit le créer à partir de la Factory correspondant (PopulationFactory ou MatrixFactory) via la méthode create.
• Quand on récupère un objet, on travaille sur l'objet lui-même, donc si après l'avoir récupéré je le modifie par un script, l'objet sera modifié dans la base de données pour la simulation dans laquelle s'applique le script. (voir les scripts de simulation)
• Pour les matrices, il est parfois intéressant de travailler sur la matrice (par exemple, multiplier une sous-dimension classe de la matrice capture en nombre par le poids de la classe pour avoir une matrice en poids) sans pour autant la modifier dans la base de données (on veut quand même garder la matrice en nombre). On doit alors travailler sur une copie de la matrice qui s'obtient en faisant:

  var copie=MatrixFactory.create(original);
  
  

Et les autres objets?

var mois= new Packages.fr.ifremer.nodb.Mois(3); //pour créer un nouveau mois 
                                                //il faut mettre new puis le 

Les objets et les opérateurs classiques

var Thon=PopulationFactory.findByName('Thon');
var Merlu=PopulationFactory.findByName('Merlu');
if (Melu.equals(Thon)){
  writeln ('bizarre'); //ce bloc ne sera pas exécuté
}
else {
  writeln ('les thons sont différents de merlus');  //celui-ci oui, pour la 
                                                    //méthode writeln voir à
                                                    //la fin
}

Concrètement à quoi ça sert?

Dans l'interface de saisie

Schéma général

result = ECMAScript(#
  //corps de la fonction: DOIT renvoyer un résultat
#);
result

Equation de croissance

• arguments disponibles: Benjamin qui est fort gentil nous donne le droit d'utiliser age qui est comme son nom l'indique un âge. Attention, c'est un âge en mois, ne pas oublier de diviser par 12 si on veut un âge en années...
• ce qu'on doit retourner: la longueur correspondant à l'âge transmis en argument

result=ECMAScript(#
  Linf = 100.0;
  K = 0.0010;
  T0 = -1.0;
  Linf*(1.0-Exp((-K*((age/12)-T0))));
#);
result

Inverse Croissance: la même sauf que c'est l'inverse

• arguments disponibles: Ca concerne les populations structurées en longueur. Ici Benjamin nous envoie la longueur
• ce qu'on doit retourner: l'âge en mois à la longueur transmise en argument

	
result=ECMAScript(#
Linf = 48.0;
K = 0.14;
t0 = 1.0;
((-t0-((1.0/K)*Ln((1.0-(longueur/Linf)))))*12.0);
#);
result

Equation de Reproduction

• arguments disponibles: un bon paquet, c'est Byzance...
  • pop la population sur laquelle on travaille
  • N la matrice N qui donne le nombre d'individus par Classe et par zone
  • mois le mois auquel on travaille
  • prepro la proportion de reproduction pour le mois courant
  • zoneRepro la liste des zones de reproduction
  • classes la liste de classe de la pop
  • zones la liste de zone de la pop
• ce qu'on doit retourner: en fait on s'en fout, on doit juste remplir une matrice result structurée en zone qui contient le nombre d'oeufs produits dans la zone à la date courante

r = ECMAScript(#
for(var izone=0; izone<zoneRepro.size(); izone++){
  var zone=zoneRepro.get(izone); // on prend le izone-ième élément de la liste
  var tot = 0.0; //on veut compter le nombre d'oeufs total produit dans la zone
  for (var iclasse=0; iclasse=pop.getClasses();iclasse++){
  //on va sommer tous les oeufs produits par toutes les classes
    var classe=pop.getClasses().get(iclasse);
    tot=tot+classe.getCoefficientFecondite()*N.getValue(classe,zone);
    //on multiplie l'effectifs de la classe dans la zone par la fécondité et on rajoute à tot
  }
  //on a finit la boucle sur les classes, on a donc tous les oeufs produits
  result.setValue(zr, tot*prepro);
  //on remplit la matrice result, on multiplie par prepro pour prendre en compte la proportion
  //de reproduction pour le mois courant
}
// on retourne une valeur qui ne sert a rien
// puisque result sera utilisé
0;
#);
r

Equation de Mortalité Naturelle: la dernière en date, elle marche impec

• arguments disponibles: classe la classe courante ou -1 pour la classe pré-recrutée; zone, la zone courante (la zone de repro courante si c'est la classe prérecrutée), pop, la pop courante
• ce qu'on doit renvoyer: tout simplement la mortalité naturelle de la classe dans la zone

result = ECMAScript(#
  var chaine=Packages.java.lang.String; //une petite astuce qui évite de refaire à chaque coup
                                        //new Packages.java.lang.String
  var nomZone=new chaine(zone.getNom()); //on convertit les chaînes primitives en
                                         //java.lang.String pour pouvoir bénéficier de la
                                         // méthode equals()
  if (classe == -1) { //cas de la classe prérecrutée
    if (nomZone.equals(new chaine('Repro31'))) 3.5;
    else 2.5;
  }
  else if (classe.getAge() == 0){ //cas de la classe 0
    if (nomZone.equals(new chaine('Recru2'))) 2;
    else 2.3;
  }
  else 1.2;
#);
result

Equation de migration - émigration - immigration

• arguments disponibles: 'classe', 'zoneDepart', 'zoneArrive' et 'N' pour les migrations; 'classe', 'zoneDepart' et 'N' pour l'émigration, 'classe', 'zoneArrive' et 'N pour l'immigration
• ce qu'on doit renvoyer: une proportion (comprise entre 0 et 1...) pour l'émigration et les migrations, un nombre pour l'immigration

#Migration
result=ECMAScript(#
if (classe.getAge()==1){
  var chaine=Packages.java.lang.String;
  var nomZoneDepart=new chaine(zoneDepart.getNom());
  var nomZoneArrive=new chaine(zoneArrive.getNom());
  if (nomZoneDepart.equals(new chaine('Recru2')) && nomZoneArrive.equals(new chaine('Recru1'))){
    var diff=N.getValue(classe,zoneDepart)-N.getValue(classe,zoneArrive);
    if ((1/diff)>1) {
      1/diff; //on a une proportion qui dépend de la diff d'effectifs
              //entre zoneDep et Zone arrive
     }
     else 0;
  }
  else 0;
}
else 0;
#);
result

#Immigration
result=ECMAScript(#
if (classe.getAge()==1){
  var chaine=Packages.java.lang.String;
  var nomZoneArrive=new chaine(zoneArrive.getNom());
  if (nomZoneArrive.equals(new chaine('gironde'))){
    N.getValue(classe,zoneArrive); //il en rentre autant qu'il y en avait
  }
  else 0;
}
else 0;
#);
result

#Emigration
result=ECMAScript(#
if (classe.getAge()==1){
  var chaine=Packages.java.lang.String;
  var nomZoneDepart=new chaine(zoneDepart.getNom());
  if (nomZoneDepart.equals(new chaine('Repro31'))){
    if (N.getValue(classe,zoneDepart)>10) 0.5; //Des que y en a un peu trop, 
                                               //ils s'en vont
  }
  else 0;
}
else 0;
#);
result

Equation de sélectivité

• arguments disponibles: longueur ou age (toujours en mois) et metier le metier courant (permet notamment de récupérer la valeur du paramètre contrôlable par les méthodes metier.getValeurParamControlable() ou pour l'avoir en string metier.getValeurParamControlableAsNumber() pour l'avoir en numérique)
• ce qu'on doit renvoyer: une proportion

	
result=ECMAScript(#
var SR=10;
var L50=27;
var beta=2*Ln(3)/SR;
var alpha=-beta*L50;
1/(1+Exp(-alpha-beta*longueur));
#);
result

Des scripts de présimulation

Des scripts tout bête

var Thon=PopulationFactory.findByName('Thon'); //j'aime bien les thons!
var classe0=Thon.getClasses().get(0); //première classe du thon
classe0.setPoidsMoyen(13); //dans ma simu, le poids moyen vaudra 13

Vers les plans de simulation

new Array("var Thon = PopulationFactory.findByName('Thon'); var classe0 = Thon.getClasses().get(0) ; classe0.setPoidsMoyen(13);",
"var Thon = PopulationFactory.findByName('Thon') ; var classe0 = Thon.getClasses().get(0) ; classe0.setPoidsMoyen(12);",
"var Thon = PopulationFactory.findByName('Thon') ; var classe0 = Thon.getClasses().get(0) ; classe0.setPoidsMoyen(11);")

var result = new Array();

for (var i=1; i<=3; i++){
  var temp="var Thon = PopulationFactory.findByName('Thon');var classe0=Thon.getClasses().get(0);classe0.setPoidsMoyen(";
  switch (i){
    case 1:
      temp+=13;
      break;
    case 2:
      temp+=12;
      break;
    case 3:
      temp+=11;
      break;
  }
  temp+=");"
  result.push(temp);   //on met en fin de tableau la chaîne temp
}
result;

Les règles de gestion

• constructeur: permet de récupérer les paramètres que l'utilisateur devra saisir pour paramétrer la règle. Ce bout de code est exécuté avant le début de la simulation, on peut donc y placer des scripts de présimulations (voir CantonnementPresimu)
• Paramètres: récupère les infos courantes date, effectifs, métier courant...
• Condition: code pour juger si le métier courant (p.metier) est affecté. Retourne un booléen
• ActionAvant: Correspond aux modifications liées à l'application de la règle avant le calcul de F. Doit retourner p.gestionMetier (cherchez pas à comprendre)
• ActionAprès: Correspond aux modifications liées à l'application de la règle après le calcul de F. Doit retourner p.gestionMetier (cherchez toujours pas à comprendre)

Quelques astuces

writeln

Obtenir un élément dans une matrice

les itérateurs