TypeScript で “radian” と “degree” を間違えないようにする

2019/02/08
このエントリーをはてなブックマークに追加
カブクでアルバイトをしている長瀬です。

今回は、degreerad, EURJPYなど、ついつい間違ってしまいがちな概念を型レベルで区別するためのアプローチを紹介します。

tl; dr

  • @fsubalさんの「TypeScript で幽霊型っぽいものをつくる」という記事で紹介されているやり方を使うとよい
  • 一方で、PureScriptなどのプログラミング言語には、既存の型1つをラップして新しい型をつくるために newtype というキーワードがある
    • TypeScriptは言語レベルではnewtypeをサポートしていないが、ライブラリとして newtype-tsがある。
      • newtype の本来の目的に加えて、その型で”正の値”, “0でない”などの条件をmonadicに表現することができる
        • そのため内部表現に変換することになり、若干の実行時オーバーヘッドがある。必要でないなら@fsubalさんのやり方を使うと良い

“単位” をどう扱うか

冒頭で挙げたようなdegreerad, EURJPYなどの”単位”を間違えないようにするためには、どうするとよいのでしょうか?すぐ思いつきそうなアプローチは、変数名で区別することです。

declare function degToRad(degree: number): number;
declare function radToDegree(rad: number): number;

const angleInDegree = 90;
const angleInRad = Math.PI / 2;
degreeToRad(angleInDegree);
radToDegree(angleInRad);

これは手軽で、ほとんどのプログラミング言語で利用できる素敵なアプローチです。しかし、うっかり変数定義を間違えてしまったりすると実行時エラーになってしまいそうです。

そこで、型レベルで degreeradian を表現することにしましょう。型を定義すればコンパイル時にエラーに気づいたり、実行時エラーのエラーメッセージをわかりやすくしたりすることができるからです。

type Degree = number;
type Rad = number;

declare function degreeToRad(degree: Degree): Rad;
const angleInDegree: Degree = 90;
const angleInRad = Math.PI / 2;

// ok!
degreeToRad(angleInDegree);
// ok!?
radToDegree(angleInRad);

TypeScriptを普段からお使いの方にとっては当然かもしれませんが、ここで radToDegree(angleInRad) はコンパイルエラーになりません。TypeScriptやその他のプログラミング言語のtype キーワードで定義した型は、単に元の型のエイリアスとなり、別の型にはならないのです。

「ユーザ定義型を使いたい」というissue(proposal)はTypeScript公式に立っているようですが、現状 Degree, Rad, number をそれぞれ別の型として定義する、一番良いアプローチは何なのでしょうか?

アプローチA. 幽霊型っぽいもの定義する

1つは、@fsubalさんの「TypeScript で幽霊型っぽいものをつくる」という記事で紹介されているアプローチです。

// https://qiita.com/fsubal/items/cbbe170edbe07d775bab
type Degree = number & { __DegreeBrand: never };
type Radian = number & { __RadianBrand: never };

const doSomething = (degree: Degree) => alert(degree.toString())

// ok
const tenInDegree = 10 as Degree;
doSomething(tenInDegree)

// not ok
// "Conversion of type 'Degree' to type 'Radian' may be a mistake because neither type sufficiently overlaps with the other."
const tenInRadian = tenInDegree as Radian;

シンプルで強力な、たいへん素晴らしいやり方です。

アプローチB. newtype-ts を使う

ところで、TypeScriptと同じAltJSである、PureScriptにおける答えはnewtype になるでしょう。PureScriptでは次のようにしてDegree, Radを定義できます。

newtype Degree = Degree Number
newtype Rad = Rad Number

これでPureScriptのコンパイラ(pscといいます)はDegreeRadを区別してくれます。もちろん、コンパイルを通した後には内部表現に使うややこしいオブジェクトの姿は消え失せて、何事もなかったかのようにnumberになっています。すばらしいですね!

しかしながら、TypeScriptにはnewtypeやそれ相当の概念はありませんので、ライブラリを使って実現することになります。newtype-tsという便利そうなライブラリを見つけたので紹介します。

まずは使い方ですが、とてもシンプルです。

import { Newtype, iso } from "newtype-ts";

interface Degree extends Newtype<{ readonly Degree: unique symbol }, number> {}

// isoDegree: Iso<Degree, number>
// 定義: https://github.com/gcanti/monocle-ts#iso
// 利用例: https://github.com/gcanti/monocle-ts/blob/master/examples/Iso.ts
const isoDegree = iso<Degree>();

// number -> Degree
const angleInDegree = isoDegree.wrap(90);
// Degree -> number
const n = isoDegree.unwrap(angleInDegree);

declare function degToRad(degree: Degree): void;

degToRad(90); // compile error
degToRad(angleInDegree); // ok!

まず、ライブラリが提供するNewtype<S, A>extendsしたDegreeインターフェイスを定義します。ここで、S{ readonly Degree: unique symbol }という型を渡しています。

unique symbol はcomputed property nameを型安全に実現するために導入された型のようです(PRに定義やサンプルコードが書いてありました)。例えば、幽霊型のアプローチで使ったこのコードですが、

type Degree = number & { __DegreeBrand: never };

unique symbol 型を使って次のように書くことができます。

type Degree = number & { readonly __DegreeBrand: unique symbol };

次に、このDegreeを使ってIsoクラスのインスタンスをつくります。Isoとは、互いに変換可能な2つの概念を表現するためのクラスで、TypeScriptでHaskellのLensようななことをするためのmonocle-tsというライブラリの内部で使われている型のようです。

monocle-tsのリポジトリにあるIsoサンプルコードを見てみましょう。

// From: https://github.com/gcanti/monocle-ts/blob/master/examples/Iso.ts
import { Iso } from '../src'

const mToKm = new Iso<number, number>(m => m / 1000, km => km * 1000)

console.log(mToKm.get(100)) // => 0.1
console.log(mToKm.reverseGet(1.2)) // => 1200

const kmToMile = new Iso<number, number>(km => km / 1.60934, miles => miles * 1.60934)

// composition
const mToMile = mToKm.compose(kmToMile)

console.log(mToMile.get(100)) // => 0.06213727366498068

“km”と”m”という互いに変換可能な概念を、型で表現していることがわかります。

newtype-tsの提供するiso関数は、先程のDegree型のようにNewTypeインターフェイスをextendsした型をジェネリクスで指定して呼び出すと、このコードのようにIsoクラスのコンストラクタに2つの概念を変換するための関数を渡してくれます。といっても、newtypeの場合は2つの概念を型レベルで区別するだけなので、取った引数をそのまま返す関数を渡しています

あとは見ての通り、isoインスタンスのwrap(), unwrap()メソッドを利用してnumber -> Degree, Degree -> number の変換をしています。

“degree” をより安全に処理する

ここまではA.のやり方でも実現できますし、むしろIsoクラスのインスタンスを作ったりする手間を考えるとA.のやり方のほうがベターです。

しかし、newtype-ts では、本来の目的に加えて”正の値”, “0でない”などの制約を型に持たせることができます。先程定義したDegree に、”90で割り切れる数である”という制約を付けてみましょう。

import { Newtype, prism, iso } from "newtype-ts"; interface Degree extends Newtype<{ readonly Degree: unique symbol }, number> {} const isMultiplesOf90 = (n: number) => n % 90 === 0; const degreeMultiplesOf90 = prism<Degree>(isMultiplesOf90); // optional90: Option<Degree> const optional90 = degreeMultiplesOf90.getOption(90); const optional5 = degreeMultiplesOf90.getOption(5); const isoDegree = iso<Degree>(); const zeroInDegree = isoDegree.wrap(0); console.log( // 90 optional90.getOrElse(zeroInDegree), // 0 optional5.getOrElse(zeroInDegree) );

prism関数は先程紹介したiso関数のように、monocle-tsのクラスPrismのインスタンスを返してくれます。Prismを使うと、ある値が”制約”を満たしている場合でもそうでない場合でも、実行時エラーにならないような安全な処理をfunctionalに書くことができます。

今回は制約としてprismconst isMultiplesOf90 = (n: number) => n % 90 === 0;という関数を渡してインスタンスを返してもらいます。このインスタンスのメソッドgetOptionは、”制約を満たす場合はその値(がsomeでラップされたsome(value))を、そうでなければnoneを返す”という関数です。

getOptionsome(value)noneを返すことがわかっているため、パターンマッチング的に安全な処理を書くことができます。ここではgetOrElseメソッドを使って、「制約を満たさない場合は0を、満たす場合はその値を返す」ように記述することができました。

さいごに

後半で紹介したnewtype-ts、そしてnewtype-tsの依存しているライブラリであるmonocle-tsは、いずれもfp-tsというライブラリの作者である@gcantiさんによるものです。最近のTypeScriptには先程挙がったcomputed property nameやunknown typeなどの強力なシステムが追加されており、@gcanti氏はこれらを巧みに利用してtype safeでfunctionalなコードを書くためのライブラリを多く公開しています。興味があれば調べてみると面白いかもしれません。(最近では代数的データ型を表現するためのボイラープレートを自動生成してくれるfp-ts-codegenが公開されました。)

カブクでは、type safeなコードやfunctionalなコードで堅牢なソフトウェアを開発したいプログラマを募集しています!

スペシャルサンクス: @kimamula(レビュー, アドバイス)

その他の記事

Other Articles

2019/06/25
カブクエンジニア開発合宿に行ってきました 2019夏


Hola! KubeCon Europe 2019の参加レポート

2019/06/19
Clean Resume きれいな環境できれいな履歴書を作成する

2019/05/20
[Web フロントエンド] 状態更新ロジックをフレームワークから独立させる

2019/04/16
C++のenable_shared_from_thisを使う

2019/04/12
OpenAPI 3 ファーストな Web アプリケーション開発(Python で API 編)

2019/04/08
WebGLでレイマーチングを使ったCSGを実現する

2019/04/02
『エンジニア採用最前線』に感化されて2週間でエンジニア主導の求人票更新フローを構築した話

2019/03/29
その1 Jetson TX2でk3s(枯山水)を動かしてみた

2019/03/27
任意のブラウザ上でJestで書いたテストを実行する

2019/02/05
Python3でGoogle Cloud ML Engineをローカルで動作する方法

2019/01/18
SIGGRAPH Asia 2018 参加レポート

2019/01/08
お正月だョ!ECMAScript Proposal全員集合!!

2019/01/08
カブクエンジニア開発合宿に行ってきました 2018秋

2018/12/25
OpenAPI 3 ファーストな Web アプリケーション開発(環境編)

2018/12/23
いまMLKitカスタムモデル(TF Lite)は使えるのか

2018/12/21
[IoT] Docker on JetsonでMQTTを使ってCloud IoT Coreと通信する

2018/12/11
TypeScriptで実現する型安全な多言語対応(Angularを例に)

2018/12/05
GASでCompute Engineの時間に応じた自動停止/起動ツールを作成する 〜GASで簡単に好きなGoogle APIを叩く方法〜

2018/12/02
single quotes な Black を vendoring して packaging

2018/11/14
3次元データに2次元データの深層学習の技術(Inception V3, ResNet)を適用

2018/11/04
Node Knockout 2018 に参戦しました

2018/10/24
SIGGRAPH 2018参加レポート-後編(VR/AR)

2018/10/11
Angular 4アプリケーションをAngular 6に移行する

2018/10/05
SIGGRAPH 2018参加レポート-特別編(VR@50)

2018/10/03
Three.jsでVRしたい

2018/10/02
SIGGRAPH 2018参加レポート-前編

2018/09/27
ズーム可能なSVGを実装する方法の解説

2018/09/25
Kerasを用いた複数入力モデル精度向上のためのTips

2018/09/21
競技プログラミングの勉強会を開催している話

2018/09/19
Ladder Netwoksによる半教師あり学習

2018/08/10
「Maker Faire Tokyo 2018」に出展しました

2018/08/02
Kerasを用いた複数時系列データを1つの深層学習モデルで学習させる方法

2018/07/26
Apollo GraphQLでWebサービスを開発してわかったこと

2018/07/19
【深層学習】時系列データに対する1次元畳み込み層の出力を可視化

2018/07/11
きたない requirements.txt から Pipenv への移行

2018/06/26
CSS Houdiniを味見する

2018/06/25
不確実性を考慮した時系列データ予測

2018/06/20
Google Colaboratory を自分のマシンで走らせる

2018/06/18
Go言語でWebAssembly

2018/06/15
カブクエンジニア開発合宿に行ってきました 2018春

2018/06/08
2018 年の tree shaking

2018/06/07
隠れマルコフモデル 入門

2018/05/30
DASKによる探索的データ分析(EDA)

2018/05/10
TensorFlowをソースからビルドする方法とその効果

2018/04/23
EGLとOpenGLを使用するコードのビルド方法〜libGLからlibOpenGLへ

2018/04/23
技術書典4にサークル参加してきました

2018/04/13
Python で Cura をバッチ実行するためには

2018/04/04
ARCoreで3Dプリント風エフェクトを実現する〜呪文による積層造形映像制作の舞台裏〜

2018/04/02
深層学習を用いた時系列データにおける異常検知

2018/04/01
音声ユーザーインターフェースを用いた新方式積層造形装置の提案

2018/03/31
Container builderでコンテナイメージをBuildしてSlackで結果を受け取る開発スタイルが捗る

2018/03/23
ngUpgrade を使って AngularJS から Angular に移行

2018/03/14
Three.jsのパフォーマンスTips

2018/02/14
C++17の新機能を試す〜その1「3次元版hypot」

2018/01/17
時系列データにおける異常検知

2018/01/11
異常検知の基礎

2018/01/09
three.ar.jsを使ったスマホAR入門

2017/12/17
Python OpenAPIライブラリ bravado-core の発展的な使い方

2017/12/15
WebAssembly(wat)を手書きする

2017/12/14
AngularJS を Angular に移行: ng-annotate 相当の機能を TypeScrpt ファイルに適用

2017/12/08
Android Thingsで4足ロボットを作る ~ Android ThingsとPCA9685でサーボ制御)

2017/12/06
Raspberry PIとDialogflow & Google Cloud Platformを利用した、3Dプリンターボット(仮)の開発 (概要編)

2017/11/20
カブクエンジニア開発合宿に行ってきました 2017秋

2017/10/19
Android Thingsを使って3Dプリント戦車を作ろう ① ハードウェア準備編

2017/10/13
第2回 魁!! GPUクラスタ on GKE ~PodからGPUを使う編~

2017/10/05
第1回 魁!! GPUクラスタ on GKE ~GPUクラスタ構築編~

2017/09/13
「Maker Faire Tokyo 2017」に出展しました。

2017/09/11
PyConJP2017に参加しました

2017/09/08
bravado-coreによるOpenAPIを利用したPythonアプリケーション開発

2017/08/23
OpenAPIのご紹介

2017/08/18
EuroPython2017で2名登壇しました。

2017/07/26
3DプリンターでLチカ

2017/07/03
Three.js r86で何が変わったのか

2017/06/21
3次元データへの深層学習の適用

2017/06/01
カブクエンジニア開発合宿に行ってきました 2017春

2017/05/08
Three.js r85で何が変わったのか

2017/04/10
GCPのGPUインスタンスでレンダリングを高速化

2017/02/07
Three.js r84で何が変わったのか

2017/01/27
Google App EngineのFlexible EnvironmentにTmpfsを導入する

2016/12/21
Three.js r83で何が変わったのか

2016/12/02
Three.jsでのクリッピング平面の利用

2016/11/08
Three.js r82で何が変わったのか

2016/12/17
SIGGRAPH 2016 レポート

2016/11/02
カブクエンジニア開発合宿に行ってきました 2016秋

2016/10/28
PyConJP2016 行きました

2016/10/17
EuroPython2016で登壇しました

2016/10/13
Angular 2.0.0ファイナルへのアップグレード

2016/10/04
Three.js r81で何が変わったのか

2016/09/14
カブクのエンジニアインターンシッププログラムについての詩

2016/09/05
カブクのエンジニアインターンとして3ヶ月でやった事 〜高橋知成の場合〜

2016/08/30
Three.js r80で何が変わったのか

2016/07/15
Three.js r79で何が変わったのか

2016/06/02
Vulkanを試してみた

2016/05/20
MakerGoの作り方

2016/05/08
TensorFlow on DockerでGPUを使えるようにする方法

2016/04/27
Blenderの3DデータをMinecraftに送りこむ

2016/04/20
Tensorflowを使ったDeep LearningにおけるGPU性能調査

→
←

関連職種

Recruit

バックエンドエンジニア(Python・Go)

業務内容

当ポジションは弊社Webサービスのバックエンド機能設計及び実装を担当します。 サービス毎の開発チームで2週間スプリントのスクラム開発を実施しています。 週次で開発チームミーティングを実施し、実装設計の相談や工数見積もりを行います。 全ての開発コードはレビューと自動テストによって品質を保っています。 また、リファクタリングやフレームワークのバージョンアップも開発フローに組込み、技術的負債を放置しない開発を目指しています。

フロントエンドエンジニア(TypeScript)

業務内容

当ポジションは弊社Webサービスのフロントエンド機能設計及び実装を担当します。 サービス毎の開発チームで2週間スプリントのスクラム開発を実施しています。 週次で開発チームミーティングを実施し、実装設計の相談や工数見積もりを行います。 全ての開発コードはレビューと自動テストによって品質を保っています。 また、リファクタリングやフレームワークのバージョンアップも開発フローに組込み、技術的負債を放置しない開発を目指しています。

機械学習エンジニア

業務内容

センサーデータの分析モデルの調査・研究・開発。 Kabuku Connectの製造データ(3D、2D)から情報を抽出するモデルの構築。 データの前処理や学習、ハイパーパラメータチューニング、獲得モデルの評価、プロダクションのデータパイプラインとの連携をお願いします。

インターン(Webエンジニア)

業務内容

業務から独立した、調査・研究系のタスクをおまかせしています。コードレビュー、 社内での報告会、 ブログ記事執筆を通して着実にスキルアップしていただくことを目指しています。 (希望があれば、プロダクトの開発業務もおまかせします。)

→
←

お客様のご要望に「Kabuku」はお応えいたします。
ぜひお気軽にご相談ください。

お電話でも受け付けております
03-6380-2750
営業時間:09:30~18:00
※土日祝は除く