# BaltamReadData

**Repository Path**: runfengtsui/baltam-read-data

## Basic Information

- **Project Name**: BaltamReadData
- **Description**: 北太天元支持连续分割符及忽略行首分隔符.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-13
- **Last Updated**: 2025-08-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 数据文件读取插件

北太天元数据文件读取插件, 弥补内置 `readmatrix` 无法处理行首分隔符以及重复分隔符的不足.

## 环境配置

本插件采用 [Xmake](https://xmake.io) 进行构建, 安装和卸载.

### Windows 系统

在 Windows 系统上, 安装 [Scoop](https://scoop.sh) 包管理工具:

```powershell
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression
```

然后安装 C/C++ 编译器 `gcc` 和构建工具 `xmake`:

```powershell
scoop install gcc xmake
```

### Linux 系统

Linux 系统自带 `gcc` 编译器, 只需安装 `xmake` 构建工具即可:

```bash
curl -fsSL https://xmake.io/shget.text | bash
```

### 配置文件

修改 `xmake.lua` 文件中 `BALTAMPATH` 变量为北太天元安装路径.

## 构建, 安装与卸载

在项目根目录下, 插件的构建, 安装与卸载分别使用如下命令：
- 使用 `xmake` 或 `xmake build` 命令进行编译构建, 编译得到的动态链接库在 `build` 对应平台文件夹中;
- 编译完成后使用 `xmake install` 命令进行安装, 插件自动安装到 `BALTAMPATH/plugins` 文件夹中;
- 卸载可以使用 `xmake uninstall` 命令, 也可以直接删除 `BALTAMPATH/plugins` 中对应的文件夹.

## 说明文档

本插件提供 `getmatrix` 函数从文本文件中读取矩阵. 语法为:

```matlab
A = getmatrix(filename, Name, Value)
```

`getmatrix` 没有实现 `readmatrix` 的全部功能, 但增加了对 `ConsecutiveDelimitersRule` 和 `LeadingDelimitersRule` 参数的支持.

### 参数说明

- `filename` 仅支持字符(串)数组格式输入的绝对路径或相对路径.
- `Delimiter`: 字段分隔符, 默认值为空格 ' '.
- `ConsecutiveDelimitersRule`: 管理连续分隔符的规则. 指定为以下值之一：
    - `split`: 将连续分隔符拆分多个字段;
    - `join`: 将多个分隔符合并成一个分隔符.

    默认值为 `join`.
- `LeadingDelimitersRule`: 管理前导分隔符的规则. 指定为以下指之一:
    - `keep`: 保留分隔符;
    - `ignore`: 忽略分隔符.

    默认值为 `ignore`.
- `NumHeaderLines`: 标题行数. 默认值为 0.