numo-binrw 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a766bc9b6b346e968a7be8047d50488d9f453459472f72635ef0cccd2e38b30
+  data.tar.gz: 42affdfac77f1093ec9a724e36a94bb23d4487f0d6ba3142ae58d3004acd91bf
+SHA512:
+  metadata.gz: d6ac610bac08f89e6558451112b1547ac9707ef38b7f1480c2d9ec8b932883c4c4892dc14e208efc295d314d40629667364fd10cd19b75705b5209df7dcbfde8
+  data.tar.gz: 1ecac661f63d943f87598978799d81e21981f2f6b3830e88f77b574586675e1660b64649d65794692d5e6b3f1685213859a146a52c3243b31a72f56c585d01af

data/.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: build
+
+on: 
+  push:
+
+jobs:
+  release-versions:
+    name: Build narray-fromfile
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version : 2.7
+      - name: Bundle install
+        run: bundle install
+      - name: Install a gem
+        run: rake install
+      - name: Test
+        run: rake test
+        

data/.gitignore

@@ -0,0 +1,59 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+*.bin
+*.dat

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in numo-binrw.gemspec
+gemspec
+
+

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    numo-binrw (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    numo-narray (0.9.2.0)
+    rake (13.0.6)
+    rake-compiler (1.1.1)
+      rake
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  numo-binrw!
+  numo-narray (~> 0.9.2.0)
+  rake (>= 12.3.3)
+  rake-compiler (~> 1.1.1)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 MURATA Mitsuharu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# numo-binrw
+
+[![build](https://github.com/Himeyama/numo-binrw/actions/workflows/build.yml/badge.svg)](https://github.com/Himeyama/numo-binrw/actions/workflows/build.yml)
+
+## 開発状況
+- [x] 書き込み
+    - [x] 複数のファイル書き込み
+    - 対応型
+        - [x] 倍精度浮動小数点数
+        - [x] 単精度浮動小数点
+        - [x] 32 Bit 整数
+        - [x] 64 Bit 整数
+- [x] 読み込み
+    - [x] 複数のファイルから読み込み
+    - 対応型
+        - [x] 倍精度浮動小数点数
+        - [x] 単精度浮動小数点
+        - [x] 32 Bit 整数
+        - [x] 64 Bit 整数
+
+## 使用法
+```rb
+require "numo/binrw"
+
+# 書き込み (例: 倍精度浮動小数点数)
+a = Numo::DFloat.cast(0...100)
+a.bin_write("dfdata.bin")
+
+# 他の型で書き込み (例: 単精度浮動小数点)
+b = Numo::SFloat.cast(0...100)
+b.bin_write("fdata.bin")
+
+# 複数ファイルに書き込み
+c = Numo::Int32.cast(0...100).reshape(4, true)
+c.bin_write(["idata01.bin", "idata02.bin", "idata03.bin", "idata04.bin"])
+
+# 読み込み
+d = Numo::Int32.bin_read("idata01.bin")
+p d
+
+## 複数ファイルから読み込み
+e = Numo::Int32.bin_read(["idata01.bin", "idata02.bin", "idata03.bin", "idata04.bin"])
+p e
+```
+
+## To do
+- rubygems に公開
+
+## インストール
+```sh
+git clone https://github.com/Himeyama/numo-binrw.git
+cd numo-binrw
+rake install
+```

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]
+
+
+require "rake/extensiontask"
+Rake::ExtensionTask.new "numo/binrw" do |ext|
+    ext.lib_dir = "ext"
+end
+
+require "rake/testtask"
+Rake::TestTask.new :test do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.verbose = true
+    t.test_files = FileList["test/*.rb"]
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "numo/binrw"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/.gitignore

@@ -0,0 +1,2 @@
+*.so
+*.o

data/ext/numo/binrw/binrw.c

@@ -0,0 +1,22 @@
+#include <stdio.h>
+#include <ruby.h>
+#include <numo/narray.h>
+#include "lib.h"
+#include "read.h"
+#include "write.h"
+
+extern VALUE numo_cDFloat;
+extern VALUE numo_cSFloat;
+extern VALUE numo_cInt32;
+extern VALUE numo_cInt64;
+extern VALUE rb_mNumo;
+
+
+VALUE rb_cBinrw;
+
+void Init_binrw(void){
+    rb_cBinrw = rb_define_module_under(rb_mNumo, "Binrw");
+    rb_define_module_function(rb_cBinrw, "_bin_write", nrw_bin_write, 2);
+
+    rb_define_module_function(rb_cBinrw, "_bin_read", nrw_bin_read, 2);
+}

data/ext/numo/binrw/extconf.rb

@@ -0,0 +1,7 @@
+require "mkmf"
+
+narray_dir = Gem.find_files("numo").map{|e| e.include?("narray") ? e : false}.select{|e| e}.to_a[0]
+dir_config('narray', narray_dir, narray_dir)
+have_library("narray")
+
+create_makefile "numo/binrw"

data/ext/numo/binrw/lib.c

@@ -0,0 +1,8 @@
+#include <sys/stat.h>
+
+long fsize(const char* filename){
+    struct stat s;
+    if(stat(filename, &s) == 0)
+        return s.st_size;
+    return -1;
+}

data/ext/numo/binrw/lib.h

@@ -0,0 +1,6 @@
+#ifndef LIB_H
+#define LIB_H
+
+long fsize(const char* filename);
+
+#endif

data/ext/numo/binrw/read.c

@@ -0,0 +1,54 @@
+#include <ruby.h>
+#include <numo/narray.h>
+
+#define rb_is_a(obj, cls) (rb_funcall(obj, rb_intern("is_a?"), 1, cls) == Qtrue)
+
+
+struct bin_read_arg_ret{
+    const char* filename;
+    void *data;
+    long size;
+    int ssize;
+    bool r;
+};
+
+void bin_read(struct bin_read_arg_ret* st){
+    FILE* fp = fopen(st->filename, "r");
+    if(fp){
+        long size;
+        size = fread(st->data, st->ssize, st->size, fp);
+        if(size != st->size){
+            st->r = false;
+            return;
+        }
+        fclose(fp);
+    }else{
+        st->r = false;
+        return;
+    }
+    st->r = true;
+}
+
+VALUE nrw_bin_read(VALUE self, VALUE cls, VALUE filename){
+    long size = NUM2LONG(rb_funcall(rb_funcall(rb_cFile, rb_intern("stat"), 1, filename), rb_intern("size"), 0));
+    struct bin_read_arg_ret st;
+    int ssize;
+    if(cls == numo_cDFloat){
+        ssize = 8;
+    }else if(cls == numo_cSFloat){
+        ssize = 4;
+    }else if(cls == numo_cInt32){
+        ssize = 4;
+    }else if(cls == numo_cInt64){
+        ssize = 8;
+    }else{
+        return Qfalse; // 非対応クラス
+    }
+    VALUE na = rb_funcall(cls, rb_intern("zeros"), 1, LONG2NUM(size / ssize));
+    st.data = na_get_pointer(na);
+    st.filename = StringValuePtr(filename);
+    st.size = size;
+    st.ssize = ssize;
+    bin_read(&st);
+    return na;
+}

data/ext/numo/binrw/read.h

@@ -0,0 +1,6 @@
+#ifndef READ_H
+#define READ_H
+
+VALUE nrw_bin_read();
+
+#endif

data/ext/numo/binrw/write.c

@@ -0,0 +1,80 @@
+#include <stdbool.h>
+#include <ruby.h>
+#include <numo/narray.h>
+
+#define rb_is_a(obj, cls) (rb_funcall(obj, rb_intern("is_a?"), 1, cls) == Qtrue)
+
+struct bin_write_arg_ret{
+    const char* filename;
+    void *data;
+    long size;
+    int ssize;
+    bool r;
+};
+
+void bin_write(struct bin_write_arg_ret* st){
+    FILE* fp = fopen(st->filename, "w");
+    if(fp){
+        fwrite(st->data, st->ssize, st->size, fp);
+        fclose(fp);
+    }else{
+        st->r = false;
+        return;
+    }
+    st->r = true;
+}
+
+
+VALUE nrw_bin_write(VALUE self, VALUE obj, VALUE filename){
+    char* cfilename;
+    void* data = na_get_pointer(obj);
+    long size = NUM2LONG(rb_funcall(obj, rb_intern("size"), 0));
+
+    if(rb_is_a(filename, rb_cArray)){
+        long row = NUM2LONG(rb_funcall(filename, rb_intern("size"), 0));
+        long col = size / row;
+        struct bin_write_arg_ret st[row];
+        for(long i = 0; i < row; i++){
+            VALUE file = rb_ary_entry(filename, i);
+            cfilename = StringValuePtr(file);
+            st[i].filename = cfilename;
+            st[i].size = col;
+            if(rb_is_a(obj, numo_cDFloat)){
+                st[i].data = (double*)data + col * i;
+                st[i].ssize = 8;
+            }else if(rb_is_a(obj, numo_cSFloat)){
+                st[i].data = (float*)data + col * i;
+                st[i].ssize = 4;
+            }else if(rb_is_a(obj, numo_cInt32)){
+                st[i].data = (int32_t*)data + col * i;
+                st[i].ssize = 4;
+            }else if(rb_is_a(obj, numo_cInt64)){
+                st[i].data = (int64_t*)data + col * i;
+                st[i].ssize = 8;
+            }else{
+                return Qfalse; // 未対応クラス
+            }
+            bin_write(st + i);
+        }
+    }else if(rb_is_a(filename, rb_cString)){
+        cfilename = StringValuePtr(filename);
+        struct bin_write_arg_ret st;
+        st.filename = cfilename;
+        st.size = size;
+        st.data = data;
+        if(rb_is_a(obj, numo_cDFloat)){
+            st.ssize = 8;
+        }else if(rb_is_a(obj, numo_cSFloat)){
+            st.ssize = 4;
+        }else if(rb_is_a(obj, numo_cInt32)){
+            st.ssize = 4;
+        }else if(rb_is_a(obj, numo_cInt64)){
+            st.ssize = 8;
+        }else{
+            return Qfalse; // 未対応クラス
+        }
+        bin_write(&st);
+    }
+
+    return obj;
+}

data/ext/numo/binrw/write.h

@@ -0,0 +1,6 @@
+#ifndef WRITE_H
+#define WRITE_H
+
+VALUE nrw_bin_write(VALUE self, VALUE obj, VALUE filename);
+
+#endif

data/lib/numo/binrw.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative "binrw/version"
+
+require "numo/narray"
+require "numo/binrw.so"
+
+module Numo
+    module Binrw
+        class Error < StandardError; end
+
+        def self.bin_write(obj, filename)
+            if filename.is_a? Array
+                if obj.ndim != 2
+                    # 複数行う場合は行列
+                    raise "If multiple files are specified, it must be a matrix"
+                end
+                if obj.shape[0] != filename.size
+                    # ファイル数と行数は同じ
+                    raise "If multiple files are specified, the number of files and the number of lines must be the same"
+                end
+            elsif filename.is_a? String
+            else
+                raise
+            end
+
+            Numo::Binrw._bin_write(obj, filename)
+            obj
+        end
+
+        def self.bin_read(cls, filename)
+            if filename.is_a? Array
+                unless filename.map{|file| File.stat(file).size}.uniq.size == 1
+                    raise "The size of all data must be the same"
+                end
+                row = filename.size
+                size = File.stat(filename[0]).size
+                if cls == DFloat || cls == Int64
+                    col = size / 8
+                elsif cls == SFloat || cls == Int32
+                    col = size / 4
+                else
+                    raise "Unsupported class"
+                end
+                a = cls.zeros(row, col)
+                filename.each.with_index do |file, i|
+                    a[i, true] = bin_read(cls, file)
+                end
+                return a
+            end
+
+            Numo::Binrw._bin_read(cls, filename)
+        end
+    end
+
+    class DFloat
+        def bin_write(filename)
+            Numo::Binrw.bin_write(self, filename)
+        end
+
+        def self.bin_read(filename)
+            Numo::Binrw.bin_read(self, filename)
+        end
+    end
+
+    class SFloat
+        def bin_write(filename)
+            Numo::Binrw.bin_write(self, filename)
+        end
+
+        def self.bin_read(filename)
+            Numo::Binrw.bin_read(self, filename)
+        end
+    end
+
+    class Int32
+        def bin_write(filename)
+            Numo::Binrw.bin_write(self, filename)
+        end
+
+        def self.bin_read(filename)
+            Numo::Binrw.bin_read(self, filename)
+        end
+    end
+
+    class Int64
+        def bin_write(filename)
+            Numo::Binrw.bin_write(self, filename)
+        end
+
+        def self.bin_read(filename)
+            Numo::Binrw.bin_read(self, filename)
+        end
+    end
+end

data/lib/numo/binrw/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Numo
+  module Binrw
+    VERSION = "0.1.0"
+  end
+end

data/numo-binrw.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/numo/binrw/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "numo-binrw"
+  spec.version       = Numo::Binrw::VERSION
+  spec.authors       = ["Murata Mitsuharu"]
+  spec.email         = ["hikari.photon+mygit@gmail.com"]
+
+  spec.summary       = "Read binary files and handle them with `NArray`."
+  spec.description   = "Read binary files and handle them with `NArray`."
+  spec.homepage      = "https://github.com/himeyama/numo-binrw"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "ext"]
+  spec.extensions    = ["ext/numo/binrw/extconf.rb"]
+
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rake-compiler", "~> 1.1.1"
+  spec.add_development_dependency "numo-narray", "~> 0.9.2.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: numo-binrw
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Murata Mitsuharu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: numo-narray
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2.0
+description: Read binary files and handle them with `NArray`.
+email:
+- hikari.photon+mygit@gmail.com
+executables: []
+extensions:
+- ext/numo/binrw/extconf.rb
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/.gitignore
+- ext/numo/binrw/binrw.c
+- ext/numo/binrw/extconf.rb
+- ext/numo/binrw/lib.c
+- ext/numo/binrw/lib.h
+- ext/numo/binrw/read.c
+- ext/numo/binrw/read.h
+- ext/numo/binrw/write.c
+- ext/numo/binrw/write.h
+- lib/numo/binrw.rb
+- lib/numo/binrw/version.rb
+- numo-binrw.gemspec
+homepage: https://github.com/himeyama/numo-binrw
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Read binary files and handle them with `NArray`.
+test_files: []