Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 3.21 KB

README.md

File metadata and controls

56 lines (38 loc) · 3.21 KB

konpeito-ES3

ESDoc coverage badge MIT License

概要

高機能数値計算ライブラリ konpeito をベースに WSH JScript でも動作するように機能を絞って ES3 で動作するようにしたライブラリです。

  • Windows 上で動作する WSH JScript 用汎用ライブラリ
  • Visual Studio Code で JScript での開発を目的とする
  • 信号処理/確率計算/統計計算部分(Complex, Matrix 含む)が行える

examplesExample.wsfを実行してみれば、雰囲気はつかめるかと思います。 詳しい関数の説明は、ヘルプファイルを参照。

注意

  • 本ライブラリは、Polyfill系のコードを含んでいますが、全機能は含んでおりませんので注意してください。 各変数やメソッドは未定義の場合に設定されるようになっているため、自分のコードを使用したい場合は本ライブラリより先にincludeして下さい。 詳細は、/src/polyfill 配下のファイルを確認してください。

フォルダ構成

  • build - JScirpt で動作するライブラリ及び、Visual Studio Code 用の型定義ファイル
  • src - コンパイル前のソースコードフォルダ
  • docs - 自動生成したヘルプファイル
  • test - プログラムが正しく動作するか確認用のフォルダ
  • scripts - Node.js で実行するスクリプトファイル(package.jsonscriptsを参照)

開発環境構築

  1. プロジェクトフォルダ全体をダウンロードして、package.jsonがあるディレクトリをカレントディレクトリとする
  2. Node.js / npm をインストールしてnpm installを実行する。
  3. Visual Studio Code をインストール
  4. VSCode上で、拡張機能の ESLint をインストール
  5. examplesの中身をいじって作りたいマクロを作る。

次のような操作が行えます。

  • ビルドは、npm run build
  • 型定義ファイル(d.ts)の作成は、npm run dts
  • ヘルプファイルの作成は、npm run doc
  • サンプルファイルの実行は、npm run start (JScriptでサンプルファイルが実行される)

konpeito について

npm で公開している高機能数値計算ライブラリ konpeito です。本ライブラリ konpeito-ES3 はここから機能を絞り、 WSH JScript でも動作するように ES3 で動作するよう修正したものです。主に以下の点を変更しています。

  • ES3で未対応の get, set を使用しない
  • 予約語を用いたメソッド名をつけない(分散を表す var など)
  • 作成したクラスを用いた instanceof を使用しない

Author