Sample Demos

Running Sample Demos

1. Build Method
     Move to the $(CTRMW_IWNN_ROOT)/sampledemos directory and run omake.

     The analyzeConv.cci executable file is generated in analyzeConv/images/CTR-TS.Process.MPCore.[fast | small]/Development/.

     The searchAddWord.cci executable file is generated in analyzeConv/images/CTR-TS.Process.MPCore.[fast |small]/Development/.

     The morpho.cci executable file is generated in analyzeConv/images/CTR-TS.Process.MPCore.[fast | small]/Development/.

     The multiDicSearch.cci executable file is generated in analyzeConv/images/CTR-TS.Process.MPCore.[fast | small]/Development/.

     The otherAPIs.cci executable file is generated in analyzeConv/images/CTR-TS.Process.MPCore.[fast | small]/Development/.

2. Locating SD Card Data
     Copy only those files required for each sample code demo to the SD Card.
     Note: For a list of required files, see the sample demo list.

     (SD Card Root)
             |
           iWnn
             |
            +- anlz.txt ....................... analyzeConv,otherAPIs Sample demo input files
            +- anlz_giji.txt ............... analyzeConv Sample demo input files
            +- conv.txt ..................... analyzeConv Sample demo input file
            +- conv2.txt ................... analyzeConv Sample demo input file
            +- conv3.txt ................... analyzeConv Sample demo input file
            +- additional.txt ............ searchAddWord Sample demo input file
            +- candidate.txt ............. searchAddWord Sample demo input file
            +- reading.txt ................. searchAddWord Sample demo input file
            +- input_str.txt .............. morpho Sample demo input file
            +- input.txt ..................... multiDicSearch Sample demo input file
            +- merge1.txt ................. otherAPIs Sample demo input file
            +- merge2.txt ................. otherAPIs Sample demo input file
            +- state.txt ..................... otherAPIs Sample demo input file
            +- stroke_word.txt ....... otherAPIs Sample demo input file
            +- dic/ ............................ Dictionary files (excluding learning dictionary and user dictionary)
            +- rewrite/ ..................... multiDicSearch Sample demo learning dictionaries and user dictionaries

3. Use the debugger to load and execute the following CCI files located in images\CTR-TS.Process.MPCore.[fast | small].

4. After the sample program executes, an operating log is created in UTF-16LE format in files named Result1_*.txt through Result5_*.txt in the (SD Card Root)/iWinn/ folder on the SD Card.
      Note: The "_*" part of the operating log name displays any one of three build types (noopt, verbose, or release)_ and any one of two optimization options (f:fast or s:small).

5. Input character strings are taken from the above text file. The input strings used with the sample demo can be changed by changing the contents of this file.

Sample Demo List

analyzeConv This sample demo performs prediction conversion and consecutive-clause conversion.

     1. Initializes the dictionary set structure
     2. Loads the reading string for prediction conversion
     3. Loads the reading string for consecutive-clause conversion
     4. Initializes the iWnn engine
     5. Prediction conversion demo
          (1) Sets prediction candidate options
          (2) Gets the prediction conversion candidates
          (3) Learns the prediction candidate having the specified index
          (4) Gets derived prediction candidate
          (5) Executes prediction conversion again to confirm learning
     6. Consecutive-clause conversion demo
          (1) Performs consecutive-clause conversion
          (2) Gets phrase candidates
          (3) Learns the candidate having the specified index
          (4) Executes consecutive-clause conversion again to confirm learning
     7. Unmounts the dictionaries

     Note: The following input files and dictionaries are used by this sample.
      sdmc:/iWnn/anlz.txt
      sdmc:/iWnn/anlz_giji.txt
      sdmc:/iWnn/conv.txt
      sdmc:/iWnn/conv2.txt
      sdmc:/iWnn/conv3.txt
      sdmc:/iWnn/dic/JA/32/njubase1.a
      sdmc:/iWnn/dic/JA/32/njubase2.a
      sdmc:/iWnn/dic/JA/32/njfzk.a
      sdmc:/iWnn/dic/JA/32/njtan.a
      sdmc:/iWnn/dic/JA/32/njexyomi.a
      sdmc:/iWnn/dic/JA/njcon.a
     Note: Operating logs are created in UTF-16LE format under names of the form Result1_*.txt in the sdmc:/iWnn folder.
      - NOTE: The input text file is UTF-16BE format without BOM symbols.

searchAddWord This sample demo searches for words in the dictionary and adds words to it.

     1. Initializes the dictionary set structure
     2. Loads the string reading, candidate, and additional information for adding a word
     3. Initializes the iWnn engine
     4. Word search and registration demo
          (1)Stores reading, candidate, and additional information in the word registration structure
          (2) Registers words to the user dictionary
          (3)Searches for registered words
          (4) Gets the reading, candidate, and additional information from search results
          (5)Deletes words
     5. Unmounts dictionaries

     Note: The following input files and dictionaries are used by this sample.       sdmc:/iWnn/additional.txt
      sdmc:/iWnn/candidate.txt
      sdmc:/iWnn/reading.txt
      sdmc:/iWnn/dic/JA/32/njubase1.a
      sdmc:/iWnn/dic/JA/32/njubase2.a
      sdmc:/iWnn/dic/JA/njcon.a
     Note: Operating logs are created in UTF-16LE format under names of the form Result2_*.txt in the sdmc:/iWnn folder.
      - NOTE: The input text file is in UTF-16BE format without BOM symbols.

morpho This sample demo performs morphological analysis.

     1. Initializes the dictionary set structure
     2. Loads the string to be parsed
     3. Initializes the iWnn engine
     4. Morphological analysis demo
          (1) Performs morphological analysis
          (2) Gets parts of speech for each phrase
          (3) Learns independent words only
     5. Unmounts dictionaries

     Note: The following input files and dictionaries are used by this sample.
      sdmc:/iWnn/input_str.txt
      sdmc:/iWnn/dic/JA/32/njubase1.a
      sdmc:/iWnn/dic/JA/32/njubase2.a
      sdmc:/iWnn/dic/JA/32/njfzk.a
      sdmc:/iWnn/dic/JA/32/njtan.a
      sdmc:/iWnn/dic/JA/njcon.a
     Note: Operating logs are created in UTF-16LE format under names of the form Result3_*.txt in the sdmc:/iWnn folder.
      - NOTE: The input text file is in UTF-16BE format without BOM symbols.

multiDicSearch This sample demo performs multilingual dictionary lookup and word replacements.

     1. Loads input files
     2. Sets languages and initializes iWnn
     3. Clears the learning dictionary
     4. Prediction/derived prediction demo
     5. Consecutive-clause conversion demo
     6. Deallocates language information and exits iWnn

     Note: The following input files and dictionaries are used by this sample.
      sdmc:/iWnn/input.txt
      sdmc:/iWnn/rewrite/njuserl_*.a
      sdmc:/iWnn/rewrite/njuserw_*.a
      sdmc:/iWnn/dic/JA/32/njubase1.a
      sdmc:/iWnn/dic/JA/32/njubase2.a
      sdmc:/iWnn/dic/JA/32/njfzk.a
      sdmc:/iWnn/dic/JA/32/njtan.a
      sdmc:/iWnn/dic/JA/32/njexyomi.a
      sdmc:/iWnn/dic/JA/njcon.a
      sdmc:/iWnn/dic/ZH/CN/njcon.a
      sdmc:/iWnn/dic/ZH/CN/pinyin/GB18030/njubase1.a
      sdmc:/iWnn/dic/ZH/CN/pinyin/GB18030/njubase1.ad1
      sdmc:/iWnn/dic/ZH/CN/pinyin/GB18030/njubase2.a
      sdmc:/iWnn/dic/ZH/CN/pinyin/GB18030/njubase2.ad1
      sdmc:/iWnn/dic/ZH/CN/pinyin/GB18030/njubase3.a
      sdmc:/iWnn/dic/ZH/CN/pinyin/GB18030/njubase3.ad1
      sdmc:/iWnn/dic/ZH/CN/pinyin/GB18030/njtan.a
      sdmc:/iWnn/dic/ZH/CN/pinyin/GB18030/njtan.ad1
      sdmc:/iWnn/dic/ZH/CN/pinyin/GB18030/njexyomi.a
      sdmc:/iWnn/dic/ZH/CN/pinyin/GB18030/njexyomi.ad1
      sdmc:/iWnn/dic/ZH/TW/njcon.a
      sdmc:/iWnn/dic/ZH/TW/pinyin/njubase1.a
      sdmc:/iWnn/dic/ZH/TW/pinyin/njubase2.a
      sdmc:/iWnn/dic/ZH/TW/pinyin/njtan.a
      sdmc:/iWnn/dic/ZH/TW/pinyin/njexyomi.a
      sdmc:/iWnn/dic/ZH/TW/bopomofo/njubase1.a
      sdmc:/iWnn/dic/ZH/TW/bopomofo/njubase2.a
      sdmc:/iWnn/dic/ZH/TW/bopomofo/njtan.a
      sdmc:/iWnn/dic/ZH/TW/bopomofo/njexyomi.a
      sdmc:/iWnn/dic/KO/njcon.a
      sdmc:/iWnn/dic/KO/njubase1.a
      sdmc:/iWnn/dic/KO/njubase2.a
      sdmc:/iWnn/dic/KO/njtan.a Note: These files are not necessary if you are not using single kanji fonts.
      sdmc:/iWnn/dic/KO/njexyomi.a
      sdmc:/iWnn/dic/EN/njcon.a
      sdmc:/iWnn/dic/EN/njubase1.a
      sdmc:/iWnn/dic/EN/njubase2.a
      sdmc:/iWnn/dic/EN/njubase3.a
      sdmc:/iWnn/dic/EN/njyomi.a
      sdmc:/iWnn/dic/EN/US/njubase1us.a
      sdmc:/iWnn/dic/EN/GB/njubase1gb.a
      sdmc:/iWnn/dic/FR/njcon.a
      sdmc:/iWnn/dic/FR/FR/regular/njubase1.a
       sdmc:/iWnn/dic/FR/FR/regular/njubase2.a
      sdmc:/iWnn/dic/FR/FR/regular/njubase3.a
      sdmc:/iWnn/dic/FR/FR/regular/njexyomi.a
      sdmc:/iWnn/dic/FR/CA/regular/njubase1.a
      sdmc:/iWnn/dic/FR/CA/regular/njubase2.a
      sdmc:/iWnn/dic/FR/CA/regular/njubase3.a
      sdmc:/iWnn/dic/FR/CA/regular/njexyomi.a
      sdmc:/iWnn/dic/DE/njcon.a
      sdmc:/iWnn/dic/DE/regular/njubase1.a
      sdmc:/iWnn/dic/DE/regular/njubase2.a
      sdmc:/iWnn/dic/DE/regular/njubase3.a
      sdmc:/iWnn/dic/DE/regular/njexyomi.a
      sdmc:/iWnn/dic/ES/njcon.a
      sdmc:/iWnn/dic/ES/ES/njubase1.a
      sdmc:/iWnn/dic/ES/ES/njubase2.a
      sdmc:/iWnn/dic/ES/ES/njubase3.a
      sdmc:/iWnn/dic/ES/ES/njexyomi.a
      sdmc:/iWnn/dic/PT/njcon.a
      sdmc:/iWnn/dic/PT/PT/regular/njubase1.a
      sdmc:/iWnn/dic/PT/PT/regular/njubase2.a
      sdmc:/iWnn/dic/PT/PT/regular/njubase3.a
      sdmc:/iWnn/dic/PT/PT/regular/njexyomi.a
      sdmc:/iWnn/dic/PT/BR/regular/njubase1.a
      sdmc:/iWnn/dic/PT/BR/regular/njubase2.a
      sdmc:/iWnn/dic/PT/BR/regular/njubase3.a
      sdmc:/iWnn/dic/PT/BR/regular/njexyomi.a
      sdmc:/iWnn/dic/IT/njcon.a
      sdmc:/iWnn/dic/IT/IT/njubase1.a
      sdmc:/iWnn/dic/IT/IT/njubase2.a
      sdmc:/iWnn/dic/IT/IT/njubase3.a
      sdmc:/iWnn/dic/IT/IT/njexyomi.a
      sdmc:/iWnn/dic/RU/njcon.a
      sdmc:/iWnn/dic/RU/regular/njubase1.a
      sdmc:/iWnn/dic/RU/regular/njubase2.a
      sdmc:/iWnn/dic/RU/regular/njubase3.a
      sdmc:/iWnn/dic/RU/regular/njexyomi.a
      sdmc:/iWnn/dic/NL/njcon.a
      sdmc:/iWnn/dic/NL/NL/njubase1.a
      sdmc:/iWnn/dic/NL/NL/njubase2.a
      sdmc:/iWnn/dic/NL/NL/njubase3.a
     Note: Operating logs are created in UTF-16LE format under names of the form Result4_*.txt in the sdmc:/iWnn folder.       - NOTE: Input text files are in UTF-16BE format without BOM symbols. The only recognized newline code is a line feed coming at the lowest line of text.

     NOTE: < Input File (UTF-16BE) Single Record Format >-------------------------------------------------
     [LangTypeNo]<tab>[Mode]<tab>[InputReading]< tab>[ExpectedResult]<LF>

     [LangTypeNo]
     MULTI_LANG_TYPE_JP~MULTI_LANG_TYPE_CA_FULL See "multidic_engine.h"
     [Mode]
     0: Prediction 1: Derived prediction 2: Conversion
     [InputReading]
     Reading string
     [ExpectedResult]
     Expected result string
     (Ex.) Example of an input file that specifies multiple languages
     26<tab>0<tab>app<tab>appellieren<LF>
     41<tab>0<tab>ка<tab>как<LF>
     14<tab>0<tab>re<tab>惹<LF>
     ------------------------------------------------------------------------------------------------------------------
otherAPIs This sample demo executes various other functions.

     1. Initializes the dictionary set structure
     2. Loads reading strings for the demo
     3. Initializes the iWnn engine
     4. Situational adaptive prediction demo
     5. Standard prediction conversion and other function demos
     6. Demo for getting unconverted candidates
     7. Demo for merging candidate lists
     8. Demo for changing dictionary types
     9. Unmounts dictionaries

     Note: The following input files and dictionaries are used by this sample.
      sdmc:/iWnn/anlz.txt
      sdmc:/iWnn/merge1.txt
      sdmc:/iWnn/merge2.txt
      sdmc:/iWnn/state.txt
      sdmc:/iWnn/stroke_word.txt
      sdmc:/iWnn/dic/JA/32/njubase1.a
      sdmc:/iWnn/dic/JA/32/njubase2.a
      sdmc:/iWnn/dic/JA/32/njfzk.a
      sdmc:/iWnn/dic/JA/32/njtan.a
      sdmc:/iWnn/dic/JA/32/njexyomi.a
      sdmc:/iWnn/dic/JA/njcon.a
     Note: Operating logs are created in UTF-16LE format under names of the form Result5_*.txt in the sdmc:/iWnn folder.
      - NOTE: The input text file is UTF-16BE format without BOM symbols.


CONFIDENTIAL