Readme-iwnn-OM-1_5_0.html

iWnn (Integrated Language Processing Middleware) OnMemory Version 1.5.0

Contents

  1. Introduction
  2. Notes
  3. System Requirements
  4. Operating Environment
  5. Installation Procedure
  6. Known Bugs
  7. Package Structure
  8. Related Documents
  9. Revision History

1. Introduction

This package contains iWnn Middleware. You can use this package to provide full language-processing capabilities.
iWnn performs integrated language processing for the device in which it is embedded. It provides the following language processing capabilities.

・Multilingual prediction and conversion (Japanese, English, Chinese, Korean, etc.)
・Japanese kana-kanji conversion
・Japanese morphological analysis (delimited input, attached reading)
・Dictionary search

You can also use this package in your products.

Back to top

2. Notes

2.1 Notes on Middleware
o Type names used by the external API (including structure and function types) have been standardized to IWNN_*. Preprocessor definitions are identified by NJ_*. o Make sure the file system does not access the dictionary file (*.A) simultaneously from multiple threads in a multi-thread environment (it is not thread-safe).


2.2 Notes on Sample Programs
o To run the sample demos, copy the folder named resources/sdcard/iWnn onto an SD Card. (Put the iWnn folder in the root directory of the SD Card.))
o Dictionary files are placed on the SD Card by the sample program. Separate provisions are required in order to place the dictionary in NAND memory.
o An operating log for the sample programs is created in UTF-16LE format under the names Result1_*.txt through Result5_*.txt in the iWinn folder on the SD Card.
o The following precautions are required when using the sample programs analyzeConv, searchAddWord, morpho, and otherAPIs.       - The input text file is UTF-16BE format without a BOM symbol.
o The following precautions are required when using the multiDicSearch sample program.       - The iWnn/rewrite folder (containing an empty learning dictionary and user dictionary) must be properly located ahead of time.
      - Input text files are in UTF-16BE format without a BOM symbol. The only recognized newline code is a newline at the lowest row of the text.
      - The fuzzy-match table for single-tap input supports the following languages.
        English (US), English (GB), French, French (Quebec), German, Spanish, Portuguese, Portuguese (Brazil), Italian, Dutch
        Chinese (Traditional-Pinyin), Chinese Language (Simplified-Pinyin)
      - The fuzzy-match table for full keyboard input supports the following languages.
English (US), English (GB), French, French (Quebec), German, Spanish, Portuguese, Portuguese (Brazil), Italian, Dutch, Russian
Chinese (Traditional-Pinyin), Chinese (Simplified-Pinyin)
- Chinese (Simplified) is implemented to accept Pinyin input; Chinese (Traditional) is implemented to accept Pinyin and Zhuyin input; Cantonese is implemented to accept Cangjie input only.
      - Four-tone input is not supported. (Only the current filter function is implemented. If required, you must separately implement a process for extracting four-tone information from the input character string.)
Conversion is not supported for Chinese (Hong Kong) Cangjie input. (Only prediction is supported.)

Back to top

3. System Requirements

The following development environment is required in order to run this package.

Back to top

4. Operating Environment

This package has been confirmed to run in the following development environment versions.

Back to top

5. Installation Procedure

Package Location

Extract this package to any directory. Nintendo recommends that you put this package in a directory with a path that does not include spaces or double-byte characters. After extracting, run the setup.wsf file to configure the absolute path to the package's root directory in the CTRMW_IWNN_ROOT environment variable.

Incorporating This Library Into Your Application

Link to the following header files and libraries to include this middleware in an application.

Header Files
include/mw/iwnn/iwnnCTR.h
Libraries
library/CTR-TS.Process.MPCore/release(or verbose or noopt)/libmw_iwnn.fast.a (or libmw_iwnn.small.a)

Back to top

6. Known Bugs

The latest information, including bugs that have been discovered since the last release, can be viewed in the Technical Information section of the Developer Support website.

Back to top

7. Package Structure

The components of this package are listed below.
Note: This does not list all included files.

CTR_MW-iWnn/
    |
    +- documents/
    |    |
    |    +- API/
    |    |    |
    |    |    +- index.html … API Reference
    |    |    +- mw/
    |    |
    |    +- Manual/
    |         |
    |         +- iWnn_API_Manual.pdf … CTR iWnn Programming Manual
    |
    +- include/
    |    |
    |    +- mw/
    |         |
    |         +- iwnn/
    |               |
    |               +- iwnnCTR.h   … iWnn class include file (include file for the application)
    |               +- iwnn.h      … iWnn class include file
    |               +- engine/     … set of iWnn engine include files
    |
    +- libraries/
    |    |
    |    +- CTR-TS.Process.MPCore/
    |         |
    |         +- noopt/
    |         |    |
    |         |    +- libmw_iwnn.fast.a       … Library file (fast version)
    |         |    +- libmw_iwnn.small.a      … Library file (small version)
    |         |
    |         +- verbose/
    |         |    |
    |         |    +- libmw_iwnn.fast.a       … Library file (fast version)
    |         |    +- libmw_iwnn.small.a      … Library file (small version)
    |         |
    |         +- release/
    |              |
    |              +- libmw_iwnn.fast.a       … Library file (fast version)
    |              +- libmw_iwnn.small.a      … Library file (small version)
    |
    +- sampledemos/ …  Sample demos (5 total)
    |    |
    |    +- analyzeConv/
    |    |    |
    |    |    +- fprintf.h         … Header file
    |    |    +- fprintf.cpp       … Source file
    |    |    +- main.cpp          … Source file
    |    |    +- analyzeConv.rsf   … rsf file
    |    |    +- OMakefile         … OMakefile
    |    |
    |    +- searchAddWord/
    |    |    |
    |    |    +- fprintf.h         … Header file
    |    |    +- fprintf.cpp       … Source file
    |    |    +- main.cpp          … Source file
    |    |    +- searchAddWord.rsf  … rsf File
    |    |    +- OMakefile         … OMakefile
    |    |
    |    +- morpho/
    |    |    |
    |    |    +- fprintf.h         … Header file
    |    |    +- fprintf.cpp       … Source file
    |    |    +- main.cpp          … Source file
    |    |    +- morpho.rsf        … rsf file
    |    |    +- OMakefile         … OMakefile
    |    |
    |    +- multiDicSearch/
    |    |    |
    |    |    +- fprintf.h         … Header file
    |    |    +- fprintf.cpp       … Source file
    |    |    +- main.cpp          … Source file
    |    |    +- multiDicSearch.rsf  … rsf file
    |    |    +- OMakefile         … OMakefile
    |    |    +- multidic*.h       … Header file
    |    |    +- multidic*.cpp     … Source file
    |    |
    |    +- otherAPIs/
    |    |    |
    |    |    +- fprintf.h         … Header file
    |    |    +- fprintf.cpp       … Source file
    |    |    +- main.cpp          … Source file
    |    |    +- otherAPIs.rsf     … rsf file
    |    |    +- OMakefile         … OMakefile
    |    |
    |    +- OMakefile
    |    +- OMakeroot
    |
    +- resources/
    |    |
    |    +- result/ … Set of output text files (output result files for all sample applications)
    |    |     |
    |    |     +- Result1.txt … analyzeConv sample demo output file
    |    |     +- Result2.txt … searchAddWord sample demo output file
    |    |     +- Result3.txt … morpho sample demo output file
    |    |     +- Result4.txt … multiDicSearch sample demo output file
    |    |     +- Result5.txt … otherAPIs sample demo output file
    |    +- sdcard/ … SD Card Root
    |         |
    |         +- iWnn/ … Set of input text files and dictionary folders
    |             |
    |             +- anlz.txt  … analyzeConv, otherAPIs, sample demo input file
    |             +- anlz_giji.txt   … analyzeConv sample demo input file
    |             +- anlz_giji2.txt  … analyzeConv sample demo input file
    |             +- 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/ … Set of dictionary files (excluding the learning dictionary and user dictionary)
    |             |     |
    |             |     +- DE/
    |             |     +- EN/
    |             |     +- ES/
    |             |     +- FR/
    |             |     +- IT/
    |             |     +- JA/
    |             |     +- JA_small/
    |             |     +- KO/
    |             |     +- NL/
    |             |     +- PT/
    |             |     +- RU/
    |             |     +- ZH/
    |             +- rewrite/ … multiDicSearch sample demo learning dictionary and user dictionary
    |
    +- tools/
    |    |
    |    +- dtoa/ …  Set of tools for creating customized dictionaries
    |    |    |
    |    |    +- dtoa.exe           … The tool
    |    |    +- Dtoa_Manual_en.txt    … Tool operating manual
    |    |    +- conf               … Tool configuration file
    |    |    +- *.ux               … Sample demo input text file
    |    |    +- *.a     … Sample output dictionary files
    |    |
    |    +- roman/ … Set of Roman character input sample demos
    |         |
    |         +- Roman_Manual_en.txt … Sample demo operating manual
    |         +- cpp/
    |         |    |
    |         |    +- ResultLog/ … Output text file
    |         |    |    |
    |         |    |  +- kanaUtf16.txt … Roman character input sample demo output file
    |         |    |
    |         |    +- fprintf.h         … Header file
    |         |    +- RomanLetter.h   … Header file
    |    |    +- fprintf.cpp       … Source file
    |    |    +- main.cpp          … Source file
    |         |    +- RomanLetter.cpp … Source file
    |         |    +- roman.rsf  … rsf file
    |         |    +- OMakefile         … OMakefile
    |         |
    |         +- OMakefile
    |         +- OMakeroot
    |
    +- Readme-iwnn-OM-1_5_0.html … Readme file
    +- setup.wsf

Back to top

8. Related Documents

For more information about this middleware's specifications and how to use the tools, see the Programming Manual.
iWnn Programming Manual (PDF)

For more information about each function and to learn how to run the sample demos, see the API Reference.
CTR iWnn Middleware API Reference Manual

Back to top

9. Revision History

- OnMemory Version 1.5.0 (2014/01/17)

- OnMemory Version 1.4.1 (2013/04/11)

- OnMemory Version 1.4.0 (2013/01/10)

- OnMemory Version 1.3.1 (2012/12/21)

- Version 1.3.1 (2012/11/15)

- Version 1.3.1 (2012/06/28)

- Version 1.3.0 (2012/05/14)

- Version 1.2.7 (2012/01/11)

- Version 1.2.6 (2011/12/05)

- Version 1.2.5 (2011/11/24)

- Version 1.2.4 (2011/10/28)

- Version 1.2.3 (2011/10/21)

- Version 1.2.2 (2011/10/14)

- Version 1.2.1 (2011/09/21)

- Version 1.2.0 (2011/09/02)

- Version 1.1.2 (2011/07/08)

- Version 1.1.1 (2011/04/22)

- Version 1.1.0 (2011/03/04)

- Version 1.0.11 (2011/02/28)

- Version 1.0.10 (2010/12/22)

- Version 1.0.9 (2010/11/25)

- Version 1.0.8 (2010/11/17)

- Version 1.0.7 (2010/11/05)

- Version 1.0.6 (2010/10/05)

- Version 1.0.5 (2010/09/03)

- Version 1.0.4 (2010/07/30)

- Version 1.0.3 (2010/06/30)

- Version 1.0.2 (2010/05/14)

- Version 1.0.1 (2010/05/12)

- Version 1.0.0 (2010/05/07)

- Version 0.3.1 (2010/04/05)

- Version 0.3.0 (2010/03/31)

- Version 0.2.0 (2010/03/19)

Back to top

CONFIDENTIAL