Struct ShortFloat 

pub struct ShortFloat { /* private fields */ }

模拟nars.entity.ShortFloat

• 🚩使用u320~4294967296的范围覆盖0~10000²
• ✨原生支持四则运算
• 🎯在基本的「证据数」基础上，添加更多NAL细节功能
  • 📄原nars.inference.UtilityFunctions的「扩展逻辑与或非」
• 🚩【2024-05-02 16:05:04】搬迁自crate::entity::BudgetValue
• 🚩【2024-05-02 17:48:30】现在全部抛弃基于「不可变引用」的运算
  • ⚠️混合「传可变引用」和「直接传值」的代码将过于冗杂（并且造成接口不统一）
  • 📌在实现了Copy之后，将值的复制看作是「随处可用」的
• 🚩【2024-05-03 11:11:48】现在将其概念与「短浮点」合并

⚠️与OpenNARS不同的一点：浮点舍入问题

!📝OpenNARS的实现是「四舍五入」，而NARust的实现是「向下截断」

• ❗即便在构造时采用了Float::round，但实际效果仍然与OpenNARS不同
  • ⚡为性能考量，许多运算最后的舍入操作仍然是四舍五入（整数除法，避免转换为浮点）
• 📄这导致0.1 * 0.0005在OpenNARS中等于0.0001而在NARust中为0

OpenNARS中可行的推理：

IN: <A --> B>. %1.00;0.10% {6 : 3}
IN: <B --> C>. %1.00;0.01% {6 : 4}
1
OUT: <A --> C>. %1.00;0.00% {7 : 4;3}
OUT: <C --> A>. %1.00;0.00% {7 : 4;3}

📄OpenNARS

A float value in [0, 1], with 4 digits accuracy.

Implementations

impl ShortFloat

pub const ZERO: Self

常量「0」

pub const ONE: Self

常量「1」

pub const HALF: Self

常量「1/2」

pub fn new(value: u32) -> Result<Self, ShortFloatError>

以0~10000的整数创建（有检查）

pub fn is_in_range(value: Float) -> bool

🆕判断浮点数是否在范围内

• 📝判断「是否在范围外」直接使用「不在范围内」的逻辑
  • 📄clippy提示「manual !RangeInclusive::contains implementation」
• ✅对NaN会默认返回false，故无需担心

pub fn value_float(&self) -> Float

模拟getValue

• 🚩获取浮点值
• 🚩【2024-05-03 10:51:09】更名为value_float以暂时避免与「短浮点」的value重名

📄OpenNARS

To access the value as float

@return The current value in float

pub fn value_short(&self) -> u32

🆕获取短整数（只读）

• 🎯用于在「其它地方的impl实现」中增强性能（直接读取内部数值）

pub fn set_value(&mut self, value: Float) -> Result<(), ShortFloatError>

模拟ShortFloat.setValue

• 🚩设置浮点值（有检查）

pub fn set_value_unchecked(&mut self, value: Float)

🆕设置浮点值（无检查）

• ⚠️必须确保值在范围内

📄OpenNARS

Set new value, rounded, with validity checking

@param v The new value

pub fn float_to_short_value(value: Float) -> Result<u32, ShortFloatError>

🆕浮点转换为「短整数」（有检查）

• 🎯提取共用逻辑，以同时用于「构造」和「赋值」
• ✅无需考虑「NaN」「无限」等值：Self::is_in_range会自动判断

pub fn float_to_short_value_unchecked(value: Float) -> u32

🆕浮点转换为「短整数」（无检查）

• 🎯提取共用逻辑，以同时用于「构造」和「赋值」
• ⚠️必须确保值在范围内

pub fn is_valid_short(short: u32) -> bool

🆕判断短整数是否合法

• 🚩直接判断「是否小于等于最大值」

pub fn is_valid(&self) -> bool

🆕判断自身值是否合法

pub fn check_valid(&self) -> Result<(), ShortFloatError>

🆕检查自身值是否合法

• 🚩判断自身值是否合法，然后返回Result

pub fn validate(self) -> Result<Self, ShortFloatError>

🆕检查自身值是否合法，并返回自身

• 🚩判断自身值是否合法，然后返回Result<Self, ShortFloatError>
• 🎯用于「构造后立即检查」

pub fn from_float(value: Float) -> Self

从浮点到自身转换（不检查，直接panic）

• ❌在实现TryFrom时，无法通过From实现：conflicting implementations of trait std::convert::TryFrom<f64> for type entity::short_float::ShortFloat

! ⚠️在「范围越界」时直接panic

• 🎯降低代码冗余量（减少过多的「错误处理」）

conflicting implementation in crate `core`:
- impl<T, U> std::convert::TryFrom<U> for T
where U: std::convert::Into<T>;

pub fn to_float(&self) -> Float

pub fn set(&mut self, new_value: Self)

pub fn is_zero(&self) -> bool

pub fn is_one(&self) -> bool

pub fn is_half(&self) -> bool

pub fn value(&self) -> Float

impl ShortFloat

【派生】用于「短浮点」的实用方法

• 🚩【2024-06-20 22:21:57】现在直接对「短浮点」实现功能，不再搞特征那一套
  • 💭实际上也可以重启「短浮点特征」，但此方面Rust比Java方便，故无需徒增复杂性

📄OpenNARS

Common functions on real numbers, mostly in [0,1].

pub fn and(self, value: Self) -> Self

模拟UtilityFunctions.and

• 🚩扩展逻辑「与」
• 🚩现在直接使用ShortFloat基于的std::ops::BitAnd特征

📄OpenNARS

A function where the output is conjunctively determined by the inputs

@param arr The inputs, each in [0, 1] @return The output that is no larger than each input

pub fn and_multi(values: impl IntoIterator<Item = Self>) -> Self

🆕多个值相与

• 🚩直接派生自「两个值相与」
  • 📝「扩展逻辑与」遵循交换律和结合律

pub fn or(self, value: Self) -> Self

模拟UtilityFunctions.or

• 🚩扩展逻辑「或」
• 🚩【2024-05-02 17:53:22】利用德摩根律行事
  • 💭可能会有性能损失
• 🚩现在直接使用ShortFloat基于的std::ops::BitOr特征

📄OpenNARS

A function where the output is disjunctively determined by the inputs

@param arr The inputs, each in [0, 1] @return The output that is no smaller than each input

pub fn or_multi(values: impl IntoIterator<Item = Self>) -> Self

🆕多个值相或

• 🚩直接派生自「多个值相与」
  • 📝「扩展逻辑或」遵循交换律和结合律
  • ⚡优化：无需重复进行逻辑非

pub fn arithmetical_average(values: impl IntoIterator<Item = Self>) -> Self

复刻OpenNARS nars.inference.UtilityFunctions.aveAri

• 🚩求代数平均值
• ❌不能用impl IntoIterator<Item = Self>：要计算长度
• ⚠️迭代器不能为空

📄OpenNARS

A function where the output is the arithmetic average the inputs

@param arr The inputs, each in [0, 1] @return The arithmetic average the inputs

pub fn geometrical_average(values: impl IntoIterator<Item = Self>) -> Self

复刻OpenNARS nars.inference.UtilityFunctions.aveGeo

• 🚩求几何平均值
• ❌不能用impl IntoIterator<Item = Self>：要计算长度

📄OpenNARS

A function where the output is the geometric average the inputs

@param arr The inputs, each in [0, 1] @return The geometric average the inputs

pub fn w2c(w: Float) -> Self

从真值的「w值」到「c值」

• 📄超参数Parameters.HORIZON参见[crate::control::Parameters]

📄OpenNARS

A function to convert weight to confidence

@param w Weight of evidence, a non-negative real number @return The corresponding confidence, in [0, 1)

pub fn w2c_float(w: Float) -> Float

🎯能利用尽量直接用，避免重复转换

pub fn W2C1() -> ShortFloat

在改版OpenNARS中是常量，在此处因为「常量函数难以构建」改为变量

pub fn W2C1_float() -> Float

在改版OpenNARS中是常量，在此处因为「常量函数难以构建」改为变量

pub fn c2w(&self) -> Float

从真值的「c值」到「w值」

• 📌此处的c就是self

📄OpenNARS

A function to convert confidence to weight

@param c confidence, in [0, 1) @return The corresponding weight of evidence, a non-negative real number

pub fn max_from(&mut self, other: Self)

🆕「最大值合并」

• 🎯用于（统一）OpenNARSmerge的重复调用
• 🚩现在已经在「短浮点」中要求了Ord
• 📝【2024-05-03 14:55:29】虽然现在「预算函数」以「直接创建新值」为主范式，
  • 但在用到该函数的merge方法上，仍然是「修改」语义——需要可变引用

Trait Implementations

impl Add for ShortFloat

fn add(self, rhs: Self) -> Self::Output

内部值相加，但会检查越界

Panics

! ⚠️可能会有「数值溢出」的panic

type Output = ShortFloat

The resulting type after applying the + operator.

impl BitAnd for ShortFloat

实现「NAL逻辑与」

• 🚩【2024-05-03 11:31:18】对clippy允许「令人疑惑的代数实现」 ? 💭是否可以自动派生（主要是受到「孤儿规则」的限制）

type Output = ShortFloat

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr for ShortFloat

实现「NAL逻辑或」

• 🚩【2024-05-03 11:31:18】对clippy允许「令人疑惑的代数实现」 ? 💭是否可以自动派生（主要是受到「孤儿规则」的限制）

type Output = ShortFloat

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl Clone for ShortFloat

fn clone(&self) -> ShortFloat

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShortFloat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ShortFloat

fn default() -> ShortFloat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShortFloat

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ShortFloat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Div<usize> for ShortFloat

整数除法

fn div(self, rhs: usize) -> Self::Output

• 🚩暂且调用两次转换，在保证「使用方便」的同时保证「效果等同」

type Output = ShortFloat

The resulting type after applying the / operator.

impl Div for ShortFloat

fn div(self, rhs: Self) -> Self::Output

内部值相除，会检查越界

Panics

! ⚠️可能会有「数值溢出」的panic

type Output = ShortFloat

The resulting type after applying the / operator.

impl EvidentNumber for ShortFloat

实现「证据数值」

fn zero() -> Self

常数「0」

fn one() -> Self

常数「1」

fn root(self, n: usize) -> Self

n次开根

fn is_valid(&self) -> bool

判断其是否合法

fn try_validate(&self) -> Result<&Self, &str>

尝试验证值是否合法

fn validate(&self) -> &Self

（强制）验证其是否合法

impl Hash for ShortFloat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<usize> for ShortFloat

整数乘法

fn mul(self, rhs: usize) -> Self::Output

• 🚩暂且调用两次转换，在保证「使用方便」的同时保证「效果等同」

type Output = ShortFloat

The resulting type after applying the * operator.

impl Mul for ShortFloat

fn mul(self, rhs: Self) -> Self::Output

内部值相乘，无需检查越界

• ✅0~1的数对乘法封闭，故无需任何检查
• ⚠️乘法在最后「除以最大值」时，采用「向下取整」的方式
• ⚠️因为乘法可能会造成上界溢出，故需要转换为「双倍位类型」
  • 🚩现在直接设置为「双倍位类型」

type Output = ShortFloat

The resulting type after applying the * operator.

impl Not for ShortFloat

实现「NAL逻辑非」 ? 💭是否可以自动派生（主要是受到「孤儿规则」的限制）

type Output = ShortFloat

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for ShortFloat

fn cmp(&self, other: &ShortFloat) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ShortFloat

fn eq(&self, other: &ShortFloat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ShortFloat

fn partial_cmp(&self, other: &ShortFloat) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ShortFloat

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for ShortFloat

fn sub(self, rhs: Self) -> Self::Output

内部值相减，无需检查越界

• 📌不会减去负值，只会「小于0」越界

Panics

! ⚠️可能会有「数值溢出」的panic

type Output = ShortFloat

The resulting type after applying the - operator.

impl TryFrom<f64> for ShortFloat

实现「从浮点到『短浮点』的直接转换」 🚩直接通过「构造函数+尝试转换」实现

type Error = ShortFloatError

The type returned in the event of a conversion error.

fn try_from(value: Float) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for ShortFloat

impl Eq for ShortFloat

impl StructuralPartialEq for ShortFloat