|
libFAUDES
Sections
Index
|
1_generator.cppGo to the documentation of this file.00001 /** @file 1_generator.cpp 00002 00003 Tutorial, Generator methods. 00004 00005 The Generator class implements the 5-tuple automaton G, consisting of 00006 - Set of States Q, 00007 - Alphabet Sigma, 00008 - Transition Relation Delta, 00009 - Set of Initial States Qo, and 00010 - Set of Marked States Qm. 00011 00012 This tutorial demonstrates how to insert/erase states, events and transitions. 00013 It also demonstrates file IO. 00014 00015 @ingroup Tutorials 00016 00017 @include 1_generator.cpp 00018 */ 00019 00020 00021 #include "libfaudes.h" 00022 00023 // make faudes namespace available 00024 using namespace faudes; 00025 00026 00027 00028 ///////////////// 00029 // main program 00030 ///////////////// 00031 00032 int main() { 00033 00034 //////////////////////////////////////////// 00035 // Constructors (part 1) and filling example 00036 //////////////////////////////////////////// 00037 00038 // at first we create an empty Generator object 00039 00040 Generator g1; 00041 00042 // do some random "user interaction" stuff with the Generator g1 00043 00044 g1.InsState("s1"); 00045 g1.InsState("s2"); 00046 g1.InsState("s3"); 00047 00048 g1.InsEvent("a"); 00049 g1.InsEvent("b"); 00050 00051 g1.SetTransition("s1", "a", "s2"); 00052 g1.SetTransition("s2", "a", "s3"); 00053 g1.SetTransition("s3", "b", "s1"); 00054 00055 g1.SetInitState("s1"); 00056 g1.SetMarkedState("s2"); 00057 g1.SetMarkedState("s3"); 00058 00059 // inspect result on console 00060 00061 std::cout << "################################\n"; 00062 std::cout << "# tutorial, handcraft generator \n"; 00063 g1.Write(); 00064 std::cout << "################################\n"; 00065 00066 00067 00068 /////////////////////////////////////////////////// 00069 // Constructors (part 2) & Copying and versioning 00070 /////////////////////////////////////////////////// 00071 00072 // Create a 1:1 copy of the Generator with the copy constructor ... 00073 00074 Generator g_copy(g1); 00075 00076 // ... with assignment method, or assignement operator 00077 00078 Generator g2; 00079 g2.Assign(g1); 00080 Generator g3=g2; 00081 00082 // create a Generator copy with versioned events (for testing algorithms): 00083 // versioning by an integer. E.g. for integer 3 events {"a", "b", "c"} 00084 // become {"a_3", "b_3", "c_3"}. 00085 00086 Generator version1; 00087 g3.Version(3, version1); 00088 00089 // versioning by a string. "a" -> "a_versionstring" 00090 00091 Generator version2; 00092 g3.Version("str", version2); 00093 00094 // inspect result on console 00095 00096 std::cout << "################################\n"; 00097 std::cout << "# tutorial, version of generator \n"; 00098 version2.Write(); 00099 std::cout << "################################\n"; 00100 00101 00102 00103 /////////////////////////////////////////////// 00104 // Methods for Input/Output 00105 /////////////////////////////////////////////// 00106 00107 // read a Generator from file 00108 00109 g2.Read("data/simplemachine.gen"); 00110 00111 // create a Generator by reading a Generator file 00112 00113 Generator g4("data/simplemachine.gen"); 00114 00115 00116 // write a Generator to file 00117 // (map state indices to begin with 1) 00118 00119 g4.Write("tmp_simplemachine.gen"); 00120 00121 // write a Generator to file by appending the output 00122 // (map state indeces to begin with 1) 00123 00124 g4.Write("tmp_simplemachine.gen", std::ios::out|std::ios::app); 00125 00126 // debug output of Generator to console 00127 // (use actual state indices) 00128 00129 std::cout << "################################\n"; 00130 std::cout << "# tutorial, debug dump \n"; 00131 g4.DWrite(); 00132 std::cout << "################################\n"; 00133 00134 // create dotfile for further processing by graphviz 00135 // (map state indices to begin with 1) 00136 00137 g4.DotWrite("tmp_simplemachine.dot"); 00138 g4.DDotWrite("tmp_simplemachine_debug.dot"); 00139 00140 // there also is a convenience method, that runs graphviz to 00141 // generate graphical output; requires "dot" binary in $PATH 00142 try { 00143 g4.GraphWrite("tmp_simplemachin.png"); 00144 } catch(faudes::Exception& exception) { 00145 std::cout << "1_generator: cannot execute graphviz' dot. " << std::endl; 00146 } 00147 00148 00149 // create a debug string for an event with symbolic name + index 00150 00151 std::string str_singleevent = g1.EStr(2); 00152 00153 // create a debug string for a state with symbolic name + index. 00154 // If there is no symblic name, a symbolic name of the index is constructed. 00155 00156 std::string str_singlestate = g1.SStr(3); 00157 00158 // build string of events in the Generator's alphabet 00159 00160 std::string str_alph = g1.AlphabetToString(); 00161 00162 // build string of states in the Generator's set of states 00163 std::string str_states = g1.StatesToString(); 00164 00165 // there also are TransRelToString(), InitStatesToString() and MarkedStatesToString() 00166 00167 00168 ////////////////////////////////////// 00169 // Accessing the Generator's Members 00170 ////////////////////////////////////// 00171 00172 // get the Generator's name 00173 00174 std::string str_name = g1.Name(); 00175 00176 // set new name for Generator 00177 00178 g1.Name("NewName"); 00179 00180 00181 00182 // the core members alphabet, stateset and transitionrelation may be retrieved 00183 // as const references; ie. they can be inspected freely, but write access is 00184 // exclusively via the provided Generator methods. 00185 00186 // retrieve a const reference to and copy of the Generator's alphabet 00187 00188 const EventSet& eset_ref_alph = g1.Alphabet(); 00189 EventSet eset_copy_alph = g1.Alphabet(); 00190 00191 // you cannot alter the alphabet of a generator via an alphabet method 00192 // eset_ref_alph.Insert("new_event"); // compile time error! 00193 00194 // however, the copy can be altered, but with no effect on the original generator 00195 00196 eset_copy_alph.Insert("new_event"); 00197 if(g1.ExistsEvent("new_event")) std::cout << "### THIS CANNOT HAPPEN ###"; 00198 00199 // retrieve a const reference to and copy of the Generator's set of states "mStates" 00200 00201 const StateSet& sset_ref_states = g1.States(); 00202 StateSet sset_copy_states = g1.States(); 00203 00204 // retrieve a const reference to and a copy of the Generator's transition relation "mTransRel" 00205 00206 const TransSet& tset_ref_trel = g1.TransRel(); 00207 TransSet tset_copy_trel = g1.TransRel(); 00208 00209 // same with initial states and marked states 00210 00211 const StateSet& sset_ref_istates = g1.InitStates(); 00212 StateSet sset_copy_istates = g1.InitStates(); 00213 00214 const StateSet& sset_ref_mstates = g1.MarkedStates(); 00215 StateSet sset_copy_mstates = g1.MarkedStates(); 00216 00217 00218 00219 ////////////////////////////////////////////////////////////////////////////// 00220 // Modifying the 5-tuple Generator (X, Sigma, Delta, X0 and Xm) 00221 ////////////////////////////////////////////////////////////////////////////// 00222 00223 // insert an event by it's symbolic name in the alphabet 00224 // (if the event is not known so far, a new index for the symbolic name is generated) 00225 g1.InsEvent("newevent"); 00226 00227 00228 // insert an existing event into the Generator's alphabet (mAlphabet) 00229 // (by "existing event" we refer to an event that has been previously inserted to some Generator) 00230 00231 g1.InsEvent(1); // of course index 1 is already in the alphabet here... 00232 00233 // insert a bunch of events (EventSet) and get the integer index if requested 00234 00235 EventSet eset1; 00236 eset1.Insert("newevent1"); 00237 Idx idx_tmp = eset1.Insert("newevent2"); 00238 g1.InsEvents(eset1); 00239 00240 // delete an event from Generator ie delete from alphabet and transition relation 00241 00242 g1.DelEvent("newevent1"); // by symbolic name 00243 g1.DelEvent(idx_tmp); // by index 00244 00245 // delete a bunch of events 00246 // g1.DelEvents(eset1); // .. of course we have already deleted them before... 00247 00248 // insert a new state. The state gets a integer index that is unique within 00249 // the Generator 00250 00251 idx_tmp = g1.InsState(); // anonymous state 00252 idx_tmp = g1.InsState("newstate2"); // named state 00253 idx_tmp = g1.InsState("77"); // named state 00254 00255 // insert a new state as initial state 00256 00257 idx_tmp = g1.InsInitState(); 00258 idx_tmp = g1.InsInitState("newinitstate"); 00259 00260 // ... same for marked states 00261 00262 idx_tmp = g1.InsMarkedState(); 00263 idx_tmp = g1.InsMarkedState("newmarkedstate"); 00264 00265 00266 // delete single states from Generator ie stateset and transitionrelation 00267 00268 g1.DelState(idx_tmp); // by index (relatively fast, for algorithms) 00269 g1.DelState("newinitstate"); // by symbolic name, if name assigned 00270 00271 // delete a bunch of states 00272 // (this should be more efficient than deleting states individually) 00273 00274 StateSet stateset1; 00275 stateset1.Insert(1); 00276 stateset1.Insert(2); 00277 stateset1.Insert(3); 00278 g1.DelStates(stateset1); 00279 00280 // for further proceeding we insert some new states and events... 00281 00282 Idx idx_s10 = g1.InsState("s10"); 00283 Idx idx_s11 = g1.InsState("s11"); 00284 Idx idx_s12 = g1.InsState("s12"); 00285 Idx idx_e10 = g1.InsEvent("e10"); 00286 Idx idx_e11 = g1.InsEvent("e11"); 00287 00288 // set a state that already exists in Generator as initial state 00289 00290 g1.SetInitState(idx_s10); 00291 00292 // set a state that already exists in Generator as marked state 00293 00294 g1.SetMarkedState(idx_s11); 00295 00296 // unset an existing state as initial state (does not remove from mStates) 00297 00298 g1.ClrInitState(idx_s10); 00299 00300 // unset an existing state as marked state (does not remove from stateset) 00301 00302 g1.ClrMarkedState(idx_s10); 00303 00304 // clear all initial states (does not remove from stateset) 00305 00306 // g1.ClrInitStates(); // we do not really do it here, so it's commented 00307 00308 // clear all marked states (mStates stays untouched) 00309 00310 // g1.ClrMarkedStates(); // we do not really do it here, so it's commented 00311 00312 // set a transition for existing states and events 00313 00314 g1.SetTransition(idx_s10, idx_e10, idx_s11); // by indices 00315 g1.SetTransition("s10", "e11", "s10"); // by symbolic names (slow) 00316 00317 00318 // report back to console 00319 00320 std::cout << "################################\n"; 00321 std::cout << "# tutorial, on the way ... \n"; 00322 g1.Write(); 00323 std::cout << "################################\n"; 00324 00325 00326 // clear a transition (does not touch mStates, mInitStates and mMarkedStates) 00327 00328 g1.ClrTransition(idx_s10, idx_e10, idx_s11); // by index 00329 00330 // transitions can also be cleared by names (slower) or by an assigned 00331 // TransSet::Iterator (faster); use ClearTransRel() to remove all transitions 00332 00333 00334 // clear the symbolic name for a state in the StateSymbolTable 00335 00336 g1.ClrStateName(idx_s10); 00337 00338 // exists event index/name in mAlphabet? 00339 00340 bool bool_eventexists1 = g1.ExistsEvent("e11"); 00341 bool bool_eventexists2 = g1.ExistsEvent(2); 00342 00343 00344 // exists state in mStates? 00345 00346 bool bool_stateexists1 = g1.ExistsState(4); 00347 00348 00349 // check if a state is an initial state 00350 00351 bool bool_initstateexists = g1.ExistsInitState(4); 00352 00353 // check if a state is a marked state 00354 00355 bool bool_ismarkedstate = g1.ExistsMarkedState(4); 00356 00357 // look up event name for index in the EventSymbolTable of the event domain 00358 00359 std::string str_eventname1 = g1.EventName(1); 00360 00361 // look up event index for name in the EventSymbolTable of the event domain 00362 00363 Idx idx_eventindex = g1.EventIndex("e11"); 00364 00365 // get symbolic name assigned to state (returns "" if no name assigned). 00366 00367 std::string str_tmp = g1.StateName(idx_s10); 00368 00369 // get index for symbolic state name. only possible for state names of states in 00370 // the Generator 00371 00372 idx_tmp = g1.StateIndex("s12"); 00373 00374 // clear Generator (including alphabet) 00375 00376 g4.Clear(); 00377 00378 // get the number of events in the Generator's alphabet 00379 00380 Idx idx_eventnum = g1.AlphabetSize(); 00381 00382 // get the number of states 00383 00384 Idx idx_statenum = g1.Size(); 00385 00386 // get the number of transitions 00387 00388 Idx idx_transnum = g1.TransRelSize(); 00389 00390 // there also are InitStatesSize(), MarkedStatesSize() 00391 00392 // is the alphabet of the Generator empty? 00393 00394 bool bool_alphempty = g1.AlphabetEmpty(); 00395 00396 // is the Generator empty (number of states == 0) ? 00397 00398 bool bool_isempty = g1.Empty(); 00399 00400 // see also TransRelEmpty, InitStatesEmpty, MarkedStatesEmpty 00401 00402 00403 // insert a small loop 00404 00405 Idx initstate = g1.InsInitState("in"); 00406 Idx markedstate = g1.InsMarkedState("out"); 00407 g1.SetTransition("in","a","out"); 00408 g1.SetTransition("out","a","in"); 00409 00410 00411 // show effect on console 00412 00413 std::cout << "################################\n"; 00414 std::cout << "# tutorial, after ins and del \n"; 00415 g1.DWrite(); 00416 std::cout << "################################\n"; 00417 00418 00419 /////////////////////// 00420 // Iterators 00421 /////////////////////// 00422 00423 // since the core members are all implemented as sets, iterators 00424 // effectively are cont_iterators, i.e. you cannot change the 00425 // current value of an iterator. instead you may remove the value 00426 // and insert the new value. 00427 00428 // iteration over alphabet indices (member "mAlphabet") 00429 00430 std::cout << "################################\n"; 00431 std::cout << "# tutorial, iterators 1 \n"; 00432 EventSet::Iterator eit; 00433 for (eit = g1.AlphabetBegin(); eit != g1.AlphabetEnd(); ++eit) { 00434 std::cout << "event \"" << g1.EventName(*eit) << "\" with index "<< *eit << std::endl; 00435 } 00436 std::cout << "################################\n"; 00437 00438 // iteration over state indices (member "mStates") 00439 00440 std::cout << "################################\n"; 00441 std::cout << "# tutorial, iterators 2 \n"; 00442 StateSet::Iterator sit; 00443 for (sit = g1.StatesBegin(); sit != g1.StatesEnd(); ++sit) { 00444 std::cout << *sit << std::endl; 00445 } 00446 std::cout << "################################\n"; 00447 00448 // iteration over complete transition relation (member "mTransRel") 00449 00450 std::cout << "################################\n"; 00451 std::cout << "# tutorial, iterators 3 \n"; 00452 TransSet::Iterator tit; 00453 for (tit = g1.TransRelBegin(); tit != g1.TransRelEnd(); ++tit) { 00454 std::cout << g1.TStr(*tit) << std::endl; 00455 } 00456 std::cout << "################################\n"; 00457 00458 // iteration over transitions from a given state; note that we avoid 00459 // computation of the end of the iteration in every step 00460 00461 std::cout << "################################\n"; 00462 std::cout << "# tutorial, iterators 4 \n"; 00463 idx_tmp = g1.StateIndex("s1"); 00464 TransSet::Iterator tit_end; 00465 tit = g1.TransRelBegin(idx_tmp); 00466 tit_end = g1.TransRelEnd(idx_tmp); 00467 for (; tit != tit_end; ++tit) { 00468 std::cout << g1.TStr(*tit) << std::endl; 00469 } 00470 std::cout << "################################\n"; 00471 00472 // variations: transitions of given state index + given event index: 00473 // TransRelBegin(x1, ev) - TransRelEnd(x1, ev) 00474 00475 // iteration over initial and marked states: 00476 // InitStatesBegin() - InitStatesEnd() (member "mInitStates") 00477 // MarkedStatesBegin() - MarkedStatesEnd() (member "mMarkedStates") 00478 00479 00480 //////////////////////////////////////////////////////////// 00481 // retrieve copies of the Generator's transition releation 00482 // in different sorting orders than X1 -> Ev -> X2 00483 //////////////////////////////////////////////////////////// 00484 00485 // note: the availabity of iterator ranges depends on the sorting order; 00486 // eg iteration with specified x2 requires X2->Ev->X1 or X2->X1->Ev sorting. 00487 00488 // retrieve a copy that is sorted by X2 -> Ev -> X1 by the binary 00489 // predicate TransSort::X2EvX1. 00490 00491 TransSetX2EvX1 tset_x2evx1; 00492 g1.TransRel(tset_x2evx1); 00493 00494 // report to console 00495 00496 std::cout << "################################\n"; 00497 std::cout << "# tutorial, x2-ev-x1 sorting\n"; 00498 TransSetX2EvX1::Iterator tit2; 00499 for (tit2 = tset_x2evx1.Begin(); tit2 != tset_x2evx1.End(); ++tit2) { 00500 std::cout << g1.TStr(*tit2) << std::endl; 00501 } 00502 std::cout << "################################\n"; 00503 00504 00505 00506 //////////////////////// 00507 // Convenience Methods 00508 //////////////////////// 00509 00510 // remove all events from mAlphabet, that do not have a transition in 00511 // mTransRel: g1.MinimizeAlphabet() 00512 00513 // get an EventSet containing all the events that drive some transition 00514 00515 EventSet eset_usedevents = g1.UsedEvents(); 00516 00517 // get an EventSet containing all the events that do not drive any transition 00518 00519 EventSet eset_unusedevents = g1.UnusedEvents(); 00520 00521 // return the active event set at a given state 00522 00523 EventSet eset_activeeventset = g1.ActiveEventSet(idx_s12); 00524 00525 // return a StateSet containing all the states that are connected by 00526 // some transition 00527 00528 StateSet sset_trel_sspace = g1.TransRelStateSpace(); 00529 00530 // return a StateSet containing all the successor states of a given predecessor 00531 // state. 00532 00533 StateSet sset_successors = g1.TransRelStateSpace(idx_s12); 00534 00535 // note: if you need predecessor states, use a resorted transition relation 00536 00537 ///////////////////////////////// 00538 // Symbolic state name handling 00539 ///////////////////////////////// 00540 00541 // are symbolic state names enabled? depending on this boolean value 00542 // library functions like Determine or StateMin may create symbolic 00543 // state names. 00544 00545 bool bool_statenamesenabled = g1.StateNamesEnabled(); 00546 00547 // disable state name creation in resulting generators for functions in 00548 // the faudes library, that support this feature (nearly all) with 00549 // "false"; enable state name creation with "true". 00550 00551 g1.StateNamesEnabled(true); // anyway .. true is the default value 00552 00553 // clear existing symbolic statenames for states in the Generator 00554 00555 // g1.ClearStateNames(); 00556 00557 // set symbolic names for all states in the generator. the symbolic name becomes 00558 // the equivalent string representation of the state's integer index. This is 00559 // only usefull for debugging purposes. 00560 00561 g1.SetDefaultStateNames(); 00562 00563 00564 // show effect on console 00565 00566 std::cout << "################################\n"; 00567 std::cout << "# tutorial, default names \n"; 00568 g1.Write(); 00569 std::cout << "################################\n"; 00570 00571 00572 /////////////////////////////////// 00573 // Accessible, Coaccessible, Complete, Trim 00574 /////////////////////////////////// 00575 00576 // read example generator for reachability analysis 00577 Generator greach("data/trimness_nottrim.gen"); 00578 00579 std::cout << "################################\n"; 00580 std::cout << "# tutorial, reachability test case \n"; 00581 greach.Write(); 00582 std::cout << "# tutorial, reachability relevant sets \n"; 00583 greach.States().Write(); 00584 greach.AccessibleSet().Write(); 00585 greach.CoaccessibleSet().Write(); 00586 greach.TerminalStates().Write(); 00587 std::cout << "# tutorial, reachability analysis \n"; 00588 if(greach.IsAccessible()) 00589 std::cout << "accesibility: ok\n"; 00590 else 00591 std::cout << "accesibility: failed\n"; 00592 if(greach.IsCoaccessible()) 00593 std::cout << "coaccesibility: ok\n"; 00594 else 00595 std::cout << "coaccesibility: failed\n"; 00596 if(greach.IsComplete()) 00597 std::cout << "completeness: ok\n"; 00598 else 00599 std::cout << "completeness: failed\n"; 00600 if(greach.IsTrim()) 00601 std::cout << "trimness: ok\n"; 00602 else 00603 std::cout << "trimness: failed\n"; 00604 if(greach.IsOmegaTrim()) 00605 std::cout << "omega-trimness: ok\n"; 00606 else 00607 std::cout << "omega-trimness: failed\n"; 00608 std::cout << "################################\n"; 00609 00610 00611 // Make the Generator accessible by removing transitions and states. 00612 // The routine returns true if the generator has an initial state. 00613 Generator gaccess(greach); 00614 gaccess.Name("GAccessible"); 00615 bool bool_hasinit = gaccess.Accessible(); 00616 00617 // Make the Generator coaccessible by removing transitions and states. 00618 // The routine returns true if the generator has a marked state. 00619 Generator gcoaccess(greach); 00620 gcoaccess.Name("GCoccessible"); 00621 bool bool_hasmarked = gcoaccess.Coaccessible(); 00622 00623 // Make the Generator complete by removing transitions and states. 00624 // The routine returns true if the generator has an initial state. 00625 Generator gcompl(greach); 00626 gcompl.Name("GComplete"); 00627 gcompl.Complete(); 00628 00629 // Make the Generator trim by removing transitions and states. 00630 // The routine returns true if the generator has an initial state 00631 // and a marked state. 00632 Generator gtrim(greach); 00633 gtrim.Name("GTrim"); 00634 bool bool_isnontrivial = gtrim.Trim(); 00635 00636 // Make the Generator omega-trim by removing transitions and states. 00637 // The routine returns true if the generator has an initial state 00638 // and a marked state. 00639 Generator gotrim(greach); 00640 gotrim.Name("GOmegaTrim"); 00641 gotrim.OmegaTrim(); 00642 00643 // show effect on console 00644 std::cout << "################################\n"; 00645 std::cout << "# tutorial, reachability results \n"; 00646 gaccess.Write(); 00647 gcoaccess.Write(); 00648 gcompl.Write(); 00649 gtrim.Write(); 00650 gotrim.Write(); 00651 std::cout << "################################\n"; 00652 00653 // contribute to html docu 00654 greach.Write("tmp_greach.gen"); 00655 gaccess.Write("tmp_gaccess.gen"); 00656 gcoaccess.Write("tmp_gcoaccess.gen"); 00657 gcompl.Write("tmp_gcompl.gen"); 00658 gtrim.Write("tmp_gtrim.gen"); 00659 gotrim.Write("tmp_gotrim.gen"); 00660 00661 // Test protocol 00662 FAUDES_TEST_DUMP("accessible",gaccess); 00663 FAUDES_TEST_DUMP("coaccessible",gcoaccess); 00664 FAUDES_TEST_DUMP("complete",gcompl); 00665 FAUDES_TEST_DUMP("trim",gtrim); 00666 FAUDES_TEST_DUMP("omega trim",gotrim); 00667 00668 return 0; 00669 } 00670 00671 00672 |
libFAUDES 2.18b --- 2010-12-17 --- c++ source docu by doxygen 1.6.3