Merge pull request #252 from devlights/add-bitop-example

Add examples/basic/bitop directory & Add example

Author: devlights

examples/basic/bitop/README.md

@@ -0,0 +1,8 @@
+# サンプルリスト
+
+このディレクトリには以下のサンプルがあります。
+
+|file|example name|note|
+|----|------------|----|
+|bitop\_basic.go|bitop\_basic|基本的なビット操作のサンプルです.|
+

examples/basic/bitop/bitop_basic.go

@@ -0,0 +1,86 @@
+package bitop
+
+import (
+	"github.com/devlights/gomy/output"
+)
+
+// Basic -- 基本的なビット操作のサンプルです.
+//
+// REFERENCES:
+//   - 書籍「プログラミング言語 Go」--  P.60
+//   - https://yourbasic.org/golang/bitwise-operator-cheat-sheet/
+func Basic() error {
+	// -----------------------------------------------------
+	// ビット演算は集合演算と思うと理解しやすい.
+	//
+	// &  -- AND    , 共通部分
+	// |  -- OR     , 和
+	// ^  -- XOR    , 対称差 (どちらか一方しか持っていないもの)
+	// &^ -- AND NOT, 差 (自分しか持っていないもの)、ビットクリア
+	// -----------------------------------------------------
+
+	var (
+		x uint8 = 1<<0 | 1<<1 | 1<<5 // 00100011
+		y uint8 = 1<<1 | 1<<3        // 00001010
+	)
+
+	// フォーマットのverbに %b を指定すると2進数表記となる
+	// さらに 08 を付与して、8桁表示でゼロ埋めするように指示
+	//
+	// 補足) %#08b とすると, 先頭に 0b を付与して出力してくれる
+	output.Stdoutf("[x]", "%08b\n", x)
+	output.Stdoutf("[y]", "%08b\n", y)
+
+	output.StdoutHr()
+
+	// & は共通部分を取り出す。両方 1 のものが残る
+	output.Stdoutf("[x&y ][共通部分]", "%08b\n", x&y)
+
+	// | は和を取り出す。どちらか 1 のものが残る
+	output.Stdoutf("[x|y ][和　　　]", "%08b\n", x|y)
+
+	// ^ は対称差を取り出す。どちらか片方しか 1 のものが残る.
+	output.Stdoutf("[x^y ][対称差　]", "%08b\n", x^y)
+
+	// &^ は差を取り出す。 &^ はビットクリアともいう.
+	// x&^yは、xの個々のビットは対応するyのビットが1の場合に0となる。
+	// それ以外は、対応するxのビットがそのまま残る.
+	//
+	// 例) logパッケージの、デフォルトのフラグ設定をクリアする際に
+	//        log.SetFlags(log.Flags &^ log.LstdFlags)
+	//     としてビットクリアすると、一発でクリアできる
+	//     (デフォルトで設定されているフラグ LstdFlags なので)
+	output.Stdoutf("[x&^y][差　　　]", "%08b\n", x&^y)
+
+	output.StdoutHr()
+
+	// 特定のビットが立っているか検査
+	if x&(1<<5) != 0 {
+		output.Stdoutl("[x&(1<<5)]", "ON")
+	}
+
+	output.StdoutHr()
+
+	// 特定のビットを落とす
+	x &^= (1 << 5)
+	output.Stdoutf("[x &^= (1 << 5)]", "%08b\n", x)
+
+	// 特定のビットを立てる
+	x |= (1 << 5)
+	output.Stdoutf("[x != (1 << 5)]", "%08b\n", x)
+
+	output.StdoutHr()
+
+	// 特定のビットをトグル
+	x ^= (1 << 7)
+	output.Stdoutf("[x ^= (1 << 7)]", "%08b\n", x)
+	x ^= (1 << 7)
+	output.Stdoutf("[x ^= (1 << 7)]", "%08b\n", x)
+
+	output.StdoutHr()
+
+	// 自分の全ビットを反転
+	output.Stdoutf("[^x]", "%08b\n", ^x)
+
+	return nil
+}

examples/basic/bitop/doc.go

@@ -0,0 +1,4 @@
+/*
+Package bitop -- ビット操作についてのサンプルが配置されています.
+*/
+package bitop

examples/basic/bitop/examples.go

@@ -0,0 +1,19 @@
+package bitop
+
+import (
+	"github.com/devlights/try-golang/mappings"
+)
+
+type (
+	register struct{}
+)
+
+// NewRegister -- このパッケージ用のサンプルを登録する mappings.Register を生成します。
+func NewRegister() mappings.Register {
+	return new(register)
+}
+
+// Regist -- 登録します.
+func (r *register) Regist(m mappings.ExampleMapping) {
+	m["bitop_basic"] = Basic
+}

examples/basic/examples.go

@@ -3,6 +3,7 @@ package basic
 import (
 	"github.com/devlights/try-golang/examples/basic/array"
 	"github.com/devlights/try-golang/examples/basic/binaries"
+	"github.com/devlights/try-golang/examples/basic/bitop"
 	"github.com/devlights/try-golang/examples/basic/builtins"
 	"github.com/devlights/try-golang/examples/basic/byteop"
 	"github.com/devlights/try-golang/examples/basic/comments"
@@ -56,6 +57,7 @@ func (r *register) Regist(m mappings.ExampleMapping) {
 
 	array.NewRegister().Regist(m)
 	binaries.NewRegister().Regist(m)
+	bitop.NewRegister().Regist(m)
 	builtins.NewRegister().Regist(m)
 	byteop.NewRegister().Regist(m)
 	comments.NewRegister().Regist(m)