Some explanation in the doc for non linear systems

micmacIGN · Jan 31, 2024 · 0297f38 · 0297f38
1 parent 719f98c
commit 0297f38
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 10 deletions.
diff --git a/MMVII/Doc/Programmer/NonLinearOptim.tex b/MMVII/Doc/Programmer/NonLinearOptim.tex
@@ -970,6 +970,12 @@ \subsection{General principle}
 
 \end{itemize}
 
+
+Some detailled pseudo code will illustration of the main step are presented in 
+the file  \tt{include/MMVII\_SysSurR.h}  as commentaries under the tag \tt{cObjWithUnkowns::TypicalScenario}.
+It's highly recommanded to give a look at it, in parallel to this document.
+
+
 %---------------------------------------------
 
 \subsection{Class {\tt cSetInterUK\_MultipeObj}}

diff --git a/MMVII/git_help_mpd.txt b/MMVII/git_help_mpd.txt
@@ -7,7 +7,7 @@ git branch mpd
 git checkout mpd 
 
 
- git config --global credential.helper 'store --file ~/.git-credential' 
+git config --global credential.helper 'store --file ~/.git-credential' 
 
 
 git config --global credential.useHttpPath true

diff --git a/MMVII/include/MMVII_SysSurR.h b/MMVII/include/MMVII_SysSurR.h
@@ -653,7 +653,7 @@ template <class Type> class cSetIntervUK_OneObj;
 template <class Type> class cSetInterUK_MultipeObj;
 template <class Type> class cObjWithUnkowns;
 
-/*  Typical scenario
+/* cObjWithUnkowns::TypicalScenario
  
      //  for object having unknowns, make them inherit of cObjWithUnkowns, describe behaviour with P-utUknowsInSetInterval
      class  cObj: public cObjWithUnkowns
@@ -664,26 +664,32 @@ template <class Type> class cObjWithUnkowns;
        
 	   ...  do stuff specific to cObj ...
 
-          void P-utUknowsInSetInterval() override 
-	  {
+      void PutUknowsInSetInterval() override
+      {
+           // the object communicate, to the set it belongs to, all its unknowns
 	       mSetInterv->AddOneInterv(mUK1,4);
 	       mSetInterv->AddOneInterv(mUK2,7);
 	  }
      };
 
+     void SomeFunctionSomeWhere()
      {
         cObj aO1,aO2;
         cSetInterUK_MultipeObj<Type>  aSet;    //  create the object
-        aSet.AddOneObj(aO1); // in this call aSet will call O1->P-utUknowsInSetInterval()
+        aSet.AddOneObj(aO1); // in this call aSet will call aO1->PutUknowsInSetInterval()
         aSet.AddOneObj(aO2);
 
-	// create a sys with the vector of all unkwnon
-	cResolSysNonLinear<double> * aSys = new cResolSysNonLinear<double>(eModeSSR::eSSR_LsqDense,mSetInterv.GetVUnKnowns());
+        // create a sys with the vector of all unkwnon
+       cResolSysNonLinear<double> * aSys = new cResolSysNonLinear<double>(eModeSSR::eSSR_LsqDense,mSetInterv.GetVUnKnowns());
 
 
-	const auto & aVectSol = mSys->SolveUpdateReset();
-	// modify all unkowns with new solution, call the method OnUpdate in case object have something to do
-        mSetInterv.SetVUnKnowns(aVectSol);
+        for ( ...)
+        {
+             ....
+             const auto & aVectSol = mSys->SolveUpdateReset();
+             // modify all unkowns with new solution, call the method OnUpdate in case object have something to do
+             mSetInterv.SetVUnKnowns(aVectSol);
+        }
      }
 
 */