implementing array length stdlib function as len

This commit is contained in:
arnav
2024-12-15 15:57:49 -05:00
parent 96652a0c48
commit b7d729a4b4
10 changed files with 5135 additions and 0 deletions

View File

@ -57,6 +57,7 @@ layout: manual
* [`legAngX`](kcl/legAngX) * [`legAngX`](kcl/legAngX)
* [`legAngY`](kcl/legAngY) * [`legAngY`](kcl/legAngY)
* [`legLen`](kcl/legLen) * [`legLen`](kcl/legLen)
* [`len`](kcl/len)
* [`line`](kcl/line) * [`line`](kcl/line)
* [`lineTo`](kcl/lineTo) * [`lineTo`](kcl/lineTo)
* [`ln`](kcl/ln) * [`ln`](kcl/ln)

37
docs/kcl/len.md Normal file

File diff suppressed because one or more lines are too long

File diff suppressed because it is too large Load Diff

View File

@ -1565,3 +1565,24 @@ mod kw_fn_with_defaults {
super::execute(TEST_NAME, false).await super::execute(TEST_NAME, false).await
} }
} }
mod array_length {
const TEST_NAME: &str = "array_length";
/// Test parsing KCL.
#[test]
fn parse() {
super::parse(TEST_NAME)
}
/// Test that parsing and unparsing KCL produces the original KCL input.
#[test]
fn unparse() {
super::unparse(TEST_NAME)
}
/// Test that KCL is executed correctly.
#[tokio::test(flavor = "multi_thread")]
async fn kcl_test_execute() {
super::execute(TEST_NAME, false).await
}
}

View File

@ -254,3 +254,35 @@ pub async fn push(_exec_state: &mut ExecState, args: Args) -> Result<KclValue, K
}; };
inner_push(array, elem, &args).await inner_push(array, elem, &args).await
} }
/// Get the length of an array.
///
/// Returns the number of elements in an array.
///
/// ```no_run
/// arr = [1, 2, 3]
/// length = len(arr)
/// assertEqual(length, 3, 0.00001, "The length of the array is 3")
/// ```
#[stdlib {
name = "len",
}]
async fn inner_len(array: Vec<KclValue>, args: &Args) -> Result<KclValue, KclError> {
Ok(KclValue::Number {
value: array.len() as f64,
meta: vec![args.source_range.into()],
})
}
pub async fn len(_exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let val: KclValue = FromArgs::from_args(&args, 0)?;
let meta = vec![args.source_range];
let KclValue::Array { value: array, meta: _ } = val else {
let actual_type = val.human_friendly_type();
return Err(KclError::Semantic(KclErrorDetails {
source_ranges: meta,
message: format!("You can't get the length of a value of type {actual_type}, only an array"),
}));
};
inner_len(array, &args).await
}

View File

@ -106,6 +106,7 @@ lazy_static! {
Box::new(crate::std::array::Reduce), Box::new(crate::std::array::Reduce),
Box::new(crate::std::array::Map), Box::new(crate::std::array::Map),
Box::new(crate::std::array::Push), Box::new(crate::std::array::Push),
Box::new(crate::std::array::Len),
Box::new(crate::std::chamfer::Chamfer), Box::new(crate::std::chamfer::Chamfer),
Box::new(crate::std::fillet::Fillet), Box::new(crate::std::fillet::Fillet),
Box::new(crate::std::fillet::GetOppositeEdge), Box::new(crate::std::fillet::GetOppositeEdge),

View File

@ -0,0 +1,282 @@
---
source: kcl/src/simulation_tests.rs
description: Result of parsing array_length.kcl
---
{
"Ok": {
"body": [
{
"declaration": {
"end": 15,
"id": {
"end": 3,
"name": "arr",
"start": 0,
"type": "Identifier"
},
"init": {
"elements": [
{
"end": 8,
"raw": "1",
"start": 7,
"type": "Literal",
"type": "Literal",
"value": 1.0
},
{
"end": 11,
"raw": "2",
"start": 10,
"type": "Literal",
"type": "Literal",
"value": 2.0
},
{
"end": 14,
"raw": "3",
"start": 13,
"type": "Literal",
"type": "Literal",
"value": 3.0
}
],
"end": 15,
"start": 6,
"type": "ArrayExpression",
"type": "ArrayExpression"
},
"start": 0,
"type": "VariableDeclarator"
},
"end": 15,
"kind": "const",
"start": 0,
"type": "VariableDeclaration",
"type": "VariableDeclaration"
},
{
"declaration": {
"end": 34,
"id": {
"end": 23,
"name": "arr_len",
"start": 16,
"type": "Identifier"
},
"init": {
"arguments": [
{
"end": 33,
"name": "arr",
"start": 30,
"type": "Identifier",
"type": "Identifier"
}
],
"callee": {
"end": 29,
"name": "len",
"start": 26,
"type": "Identifier"
},
"end": 34,
"start": 26,
"type": "CallExpression",
"type": "CallExpression"
},
"start": 16,
"type": "VariableDeclarator"
},
"end": 34,
"kind": "const",
"start": 16,
"type": "VariableDeclaration",
"type": "VariableDeclaration"
},
{
"end": 99,
"expression": {
"arguments": [
{
"end": 54,
"name": "arr_len",
"start": 47,
"type": "Identifier",
"type": "Identifier"
},
{
"end": 57,
"raw": "3",
"start": 56,
"type": "Literal",
"type": "Literal",
"value": 3.0
},
{
"end": 66,
"raw": "0.00001",
"start": 59,
"type": "Literal",
"type": "Literal",
"value": 0.00001
},
{
"end": 98,
"raw": "\"The length of the array is 3\"",
"start": 68,
"type": "Literal",
"type": "Literal",
"value": "The length of the array is 3"
}
],
"callee": {
"end": 46,
"name": "assertEqual",
"start": 35,
"type": "Identifier"
},
"end": 99,
"start": 35,
"type": "CallExpression",
"type": "CallExpression"
},
"start": 35,
"type": "ExpressionStatement",
"type": "ExpressionStatement"
},
{
"declaration": {
"end": 115,
"id": {
"end": 110,
"name": "arr_empty",
"start": 101,
"type": "Identifier"
},
"init": {
"elements": [],
"end": 115,
"start": 113,
"type": "ArrayExpression",
"type": "ArrayExpression"
},
"start": 101,
"type": "VariableDeclarator"
},
"end": 115,
"kind": "const",
"start": 101,
"type": "VariableDeclaration",
"type": "VariableDeclaration"
},
{
"declaration": {
"end": 142,
"id": {
"end": 125,
"name": "len_empty",
"start": 116,
"type": "Identifier"
},
"init": {
"arguments": [
{
"end": 141,
"name": "arr_empty",
"start": 132,
"type": "Identifier",
"type": "Identifier"
}
],
"callee": {
"end": 131,
"name": "len",
"start": 128,
"type": "Identifier"
},
"end": 142,
"start": 128,
"type": "CallExpression",
"type": "CallExpression"
},
"start": 116,
"type": "VariableDeclarator"
},
"end": 142,
"kind": "const",
"start": 116,
"type": "VariableDeclaration",
"type": "VariableDeclaration"
},
{
"end": 209,
"expression": {
"arguments": [
{
"end": 164,
"name": "len_empty",
"start": 155,
"type": "Identifier",
"type": "Identifier"
},
{
"end": 167,
"raw": "0",
"start": 166,
"type": "Literal",
"type": "Literal",
"value": 0.0
},
{
"end": 176,
"raw": "0.00001",
"start": 169,
"type": "Literal",
"type": "Literal",
"value": 0.00001
},
{
"end": 208,
"raw": "\"The length of the array is 0\"",
"start": 178,
"type": "Literal",
"type": "Literal",
"value": "The length of the array is 0"
}
],
"callee": {
"end": 154,
"name": "assertEqual",
"start": 143,
"type": "Identifier"
},
"end": 209,
"start": 143,
"type": "CallExpression",
"type": "CallExpression"
},
"start": 143,
"type": "ExpressionStatement",
"type": "ExpressionStatement"
}
],
"end": 210,
"nonCodeMeta": {
"nonCodeNodes": {
"2": [
{
"end": 101,
"start": 99,
"type": "NonCodeNode",
"value": {
"type": "newLine"
}
}
]
},
"startNodes": []
},
"start": 0
}
}

View File

@ -0,0 +1,7 @@
arr = [1, 2, 3]
arr_len = len(arr)
assertEqual(arr_len, 3, 0.00001, "The length of the array is 3")
arr_empty = []
len_empty = len(arr_empty)
assertEqual(len_empty, 0, 0.00001, "The length of the array is 0")

View File

@ -0,0 +1,127 @@
---
source: kcl/src/simulation_tests.rs
description: Program memory after executing array_length.kcl
---
{
"environments": [
{
"bindings": {
"HALF_TURN": {
"type": "Number",
"value": 180.0,
"__meta": []
},
"QUARTER_TURN": {
"type": "Number",
"value": 90.0,
"__meta": []
},
"THREE_QUARTER_TURN": {
"type": "Number",
"value": 270.0,
"__meta": []
},
"ZERO": {
"type": "Number",
"value": 0.0,
"__meta": []
},
"arr": {
"type": "Array",
"value": [
{
"type": "Number",
"value": 1.0,
"__meta": [
{
"sourceRange": [
7,
8,
0
]
}
]
},
{
"type": "Number",
"value": 2.0,
"__meta": [
{
"sourceRange": [
10,
11,
0
]
}
]
},
{
"type": "Number",
"value": 3.0,
"__meta": [
{
"sourceRange": [
13,
14,
0
]
}
]
}
],
"__meta": [
{
"sourceRange": [
6,
15,
0
]
}
]
},
"arr_empty": {
"type": "Array",
"value": [],
"__meta": [
{
"sourceRange": [
113,
115,
0
]
}
]
},
"arr_len": {
"type": "Number",
"value": 3.0,
"__meta": [
{
"sourceRange": [
26,
34,
0
]
}
]
},
"len_empty": {
"type": "Number",
"value": 0.0,
"__meta": [
{
"sourceRange": [
128,
142,
0
]
}
]
}
},
"parent": null
}
],
"currentEnv": 0,
"return": null
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB