From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms8.migadu.com with LMTPS id cErDJ6GE9WVBdAAA62LTzQ:P1 (envelope-from ) for ; Sat, 16 Mar 2024 12:38:09 +0100 Received: from aspmx1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1.migadu.com with LMTPS id cErDJ6GE9WVBdAAA62LTzQ (envelope-from ) for ; Sat, 16 Mar 2024 12:38:09 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=XZ+9plie; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1710589089; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=IhAXo5AJkMr7TN+7FAzklQsiX68yEaJFT4zcX9DvT0s=; b=SAVPsKCo+kgWDWDkZ5kY0XQOlF4q7S1mMdmkaKCWDlj1VyjybX1qlh9XZON0zK+tD0IQAp KlV/uc8bX20xLNkZq6XTvGbKXNooR+Y7I74QYJhvvfti/xSs/gzVOUW7a45zNbgpC+2C5Z ohYoGm2ULjvkXWRg9FMBI13nlgoVqXxuSXxd31CdQGl7zjgsC5F2CE4RypG5KQuvG4Cpqa LPF/uvclj0p0LOxyqGIy2GMp6qvWclIH1pMul8f26uytCYfDXMccxpH1vDXsNjz4ivGwhg bhjvjno/esA23bVx1YLJhesN1fS82SbBdaehDfKHGWvouJ1CejopU6lOYiqmvg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=XZ+9plie; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=key1; d=yhetil.org; t=1710589089; a=rsa-sha256; cv=none; b=f++wS6LEqmJACbD1zKLMTC1dpa1jEp02pKkvYZGectBuOf0giTlAqGOE/LyyKfeNtZ8W9b zQEtq0sP8km2PD6uJO1KdMwHggQ5Es/kQDBRCPzvcnRa3sm8NAe8TvgPzSMcleoV4lgLRa i/FZEqdikLQ+N8XTbuMUIxfIUHkNCPtLM66iMSBBims060oJQgCQAzA9wbfrwIyA1i4/Wp hFgkgy2sB7Xk57Elv1ZfqIBPXtueC6Wv78hnOtv70xQBw9/I+agcZ5IwkLWtwXmuSYBiD6 BbwA43lJ1DfSjfLkjchgogdk/UpuZGTjQnu2jUbozyd94PrTIbbneZ6C/TkC1Q== Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 490A011A92 for ; Sat, 16 Mar 2024 12:38:09 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rlSMK-0001p1-Kz; Sat, 16 Mar 2024 07:37:52 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rlSMJ-0001on-7r for emacs-orgmode@gnu.org; Sat, 16 Mar 2024 07:37:51 -0400 Received: from mail-pl1-x643.google.com ([2607:f8b0:4864:20::643]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rlSMD-0004wc-NJ for emacs-orgmode@gnu.org; Sat, 16 Mar 2024 07:37:50 -0400 Received: by mail-pl1-x643.google.com with SMTP id d9443c01a7336-1def3340682so11733745ad.1 for ; Sat, 16 Mar 2024 04:37:45 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1710589064; x=1711193864; darn=gnu.org; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=IhAXo5AJkMr7TN+7FAzklQsiX68yEaJFT4zcX9DvT0s=; b=XZ+9plieaX0zXEyFfJjlEicLcGD5vlU1s7JvPCd7rIu2e+sylFQuXovSZ90PwSfxfD dRy+NSXu1Pw3viQeS5NY0G0/jGsht6ID5OB8hMqt4hPV4qy0Z2XWNvo9SyFVEgj5rJvB f57YmoDPMpqjrB8jt0yNjCJRCWFXNITBtmemBxH88OSQyqRhXdB9sd0lTOCyl8Ifh+Ra /AeeM6NlyMf1Mo/I8gSiM/u3+uz7ZXwPy7jpGNJjJ1mFlO2DZttQ8EXsbmGve4VUl3NG GxZuTCKWLlvC/MGnEVFehyeml/qFoUsKTkKl5Y7JuxQOHabDZEGNASkL6Nb6mfo2cAul qqQg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1710589064; x=1711193864; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=IhAXo5AJkMr7TN+7FAzklQsiX68yEaJFT4zcX9DvT0s=; b=OulzpxchR8Ygfw3mCJro10FRJ2kyziiLH4moNNh+3vdGDFBwDSuJUaf7ii/cXRzs+t v2/x0lC7ppvxWTyAZ4JlAfR1Z4Hes1wzR9RwrPFnLH3FhUO0UsTk03m0T4LMkToaoEdn WP8y0gYs2RXK6Llb4BSWZHb5FRDjg5OCAJ09t4P7V0ub64BmCyJsjjW04+aO9ZQf0Gyx DHyuoCf892JWKaKfFbhYTYnMwWCQae9wfhp0KVpqQhv4LMGP/+Na4+FGCrRaB6VO5J1F sSD0qxSTJcZfHTwq/igj1K0xwG7QcLm15kRSm9ijNOKWGbFndNyPUysmInzXs1VjGBPZ DFDw== X-Gm-Message-State: AOJu0Yx4/DpDCc3TgurHjWkPr9IrgvEmjU1EpGQji+GVSUlKSi8aKOdK ArWdAA2cTjuNM7buQ3n01QsyJtZUVp/UGCdqWp9Ezb0TQNicBz86RClkgo+QRoY= X-Google-Smtp-Source: AGHT+IHrL1tHE6+f+KN1lHRMaNn8yS70oJv1ezr7Ew5WMSPfgVWkiOm8ndEq9j2nCw2ckOJeD74eCg== X-Received: by 2002:a17:902:c948:b0:1dd:96e5:d22b with SMTP id i8-20020a170902c94800b001dd96e5d22bmr10636697pla.49.1710589063700; Sat, 16 Mar 2024 04:37:43 -0700 (PDT) Received: from localhost ([1.7.159.70]) by smtp.gmail.com with ESMTPSA id la11-20020a170902fa0b00b001dd2b9ed407sm5611995plb.213.2024.03.16.04.37.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 Mar 2024 04:37:43 -0700 (PDT) From: Visuwesh To: Ihor Radchenko Cc: emacs-orgmode@gnu.org Subject: Re: [PATCH] Add support for tables in Calc src block :var In-Reply-To: <87y1aiijv3.fsf@localhost> (Ihor Radchenko's message of "Sat, 16 Mar 2024 09:52:48 +0000") References: <877ci2261h.fsf@gmail.com> <87y1aiijv3.fsf@localhost> Date: Sat, 16 Mar 2024 17:07:39 +0530 Message-ID: <8734sq1k70.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=2607:f8b0:4864:20::643; envelope-from=visuweshm@gmail.com; helo=mail-pl1-x643.google.com X-Spam_score_int: 12 X-Spam_score: 1.2 X-Spam_bar: + X-Spam_report: (1.2 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_SBL_CSS=3.335, SPF_HELO_NONE=0.001, T_SCC_BODY_TEXT_LINE=-0.01, T_SPF_TEMPERROR=0.01 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Country: US X-Migadu-Flow: FLOW_IN X-Migadu-Scanner: mx12.migadu.com X-Migadu-Spam-Score: -9.58 X-Spam-Score: -9.58 X-Migadu-Queue-Id: 490A011A92 X-TUID: xJuOUKRc3P0z --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable [=E0=AE=9A=E0=AE=A9=E0=AE=BF =E0=AE=AE=E0=AE=BE=E0=AE=B0=E0=AF=8D=E0=AE=9A= =E0=AF=8D 16, 2024] Ihor Radchenko wrote: > Visuwesh writes: > >> Attached patch adds support for passing tables as matrices (or vector) >> to a Calc source block through the :var parameter. There might be a >> better way to do it than manually construct the data structure expected >> by Calc for a matrix but given that it rarely sees changes in this area, >> it shouldn't be a bother. >> I also added tests for this feature, and other simple tests to ensure >> everything works. I checked that all the tests passed on my side. > > Thanks! > Since you are adding a new feature, may you also add an entry to etc/ORG-= NEWS? Now done. >> - (calc-push-list (list (cdr pair))) >> + (let ((val (cdr pair))) >> + (calc-push-list >> + (list (if (listp val) >> + (cons 'vec >> + (if (null (cdr val)) >> + (car val) >> + (mapcar (lambda (x) (if (listp x) (cons 've= c x) x)) >> + val))) >> + val)))) > > It would be nice to add code comments explaining the Calc's internal > format. Ideally, with references to Calc's manual or source code. > Otherwise, this code looks like black magic :) I hope the comment I added in the attached patch is clear enough. >> +++ b/testing/examples/ob-calc-test.org >> @@ -0,0 +1,57 @@ >> +#+TITLE: Tests for ob-calc >> +#+OPTIONS: ^:nil > > Thanks a lot for adding many tests! > Would you mind using `org-test-with-temp-text' instead of > `org-test-at-id' as much as possible? Otherwise, looking at tests like OK, I wasn't sure what test style to use since the README in testing/ does not talk about writing new tests. Now I have adapted the tests to use org-test-with-temp-text. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-ob-calc.el-Add-support-for-tables-in-Calc-source-blo.patch >From 29962bc3ec33e1e25f83f153b681d49182368592 Mon Sep 17 00:00:00 2001 From: Visuwesh Date: Sat, 16 Mar 2024 17:04:14 +0530 Subject: [PATCH] ob-calc.el: Add support for tables in Calc source block :var A table with MxN dimensions is converted to a MxN matrix when given in :var to a Calc source block. A table with a single row is converted to a vector (i.e., row vector). * lisp/ob-calc.el (org-babel-execute-src-block:calc): Construct the right data structure to pass tables as matrices to Calc. * testing/lisp/test-ob-calc.el: Add tests for ob-calc, and this new feature. * etc/ORG-NEWS: Announce the feature. --- etc/ORG-NEWS | 7 +++ lisp/ob-calc.el | 14 ++++- testing/lisp/test-ob-calc.el | 115 +++++++++++++++++++++++++++++++++++ 3 files changed, 135 insertions(+), 1 deletion(-) create mode 100644 testing/lisp/test-ob-calc.el diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index ca73f06e7..197d7503d 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -1121,6 +1121,13 @@ Maxima's graphics packages (~draw~ or ~plot~); the default remains ~plot~. The graphics terminal is now determined from the file-ending of the file-name set in the ~:file~ header argument. +*** =ob-calc.el=: Support for tables in ~:var~ + +=ob-calc= now supports tables in ~:var~. They are converted to a +matrix or a vector depending on the dimensionality of the table. A +table with a single row is converted to a vector, the rest are +converted to a matrix. + *** Images and files in clipboard can be pasted Org asks the user what must be done when pasting images and files diff --git a/lisp/ob-calc.el b/lisp/ob-calc.el index f36df77ff..810ed1735 100644 --- a/lisp/ob-calc.el +++ b/lisp/ob-calc.el @@ -64,7 +64,19 @@ (var-names (mapcar #'symbol-name org--var-syms))) (mapc (lambda (pair) - (calc-push-list (list (cdr pair))) + (let ((val (cdr pair))) + (calc-push-list + ;; For a vector, Calc follows the format (vec 1 2 3 ...) so + ;; a matrix becomes (vec (vec 1 2 3) (vec 4 5 6) ...). See + ;; the comments in "Arithmetic routines." section of + ;; calc.el. + (list (if (listp val) + (cons 'vec + (if (null (cdr val)) + (car val) + (mapcar (lambda (x) (if (listp x) (cons 'vec x) x)) + val))) + val)))) (calc-store-into (car pair))) vars) (mapc diff --git a/testing/lisp/test-ob-calc.el b/testing/lisp/test-ob-calc.el new file mode 100644 index 000000000..6d6ca104d --- /dev/null +++ b/testing/lisp/test-ob-calc.el @@ -0,0 +1,115 @@ +;;; test-ob-calc.el --- tests for ob-calc.el -*- lexical-binding: t; -*- + +;; Copyright (C) 2024 Visuwesh + +;; Author: Visuwesh + +;; This program is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;;; Code: +(require 'ob-calc) + +(unless (featurep 'ob-calc) + (signal 'missing-test-dependency "Support for Calc code blocks")) + +(ert-deftest ob-calc/simple-program-mult () + "Test of simple multiplication." + (org-test-with-temp-text "\ +#+BEGIN_SRC calc :results silent + 1 * 2 +#+END_SRC" + (should (equal "2" (org-babel-execute-src-block))))) + +(ert-deftest ob-calc/simple-program-arith () + "Test of simple arithmetic." + (org-test-with-temp-text "\ +#+BEGIN_SRC calc :results silent + 12 + 16 - 1 +#+END_SRC" + (should (equal "27" (org-babel-execute-src-block))))) + +(ert-deftest ob-calc/simple-program-symbolic () + "Test of simple symbolic algebra." + (org-test-with-temp-text "\ +#+BEGIN_SRC calc :results silent + inv(a) +#+END_SRC" + (should (equal "1 / a" (org-babel-execute-src-block))))) + +(ert-deftest ob-calc/matrix-inversion () + "Test of a matrix inversion." + (org-test-with-temp-text "\ +#+NAME: ob-calc-table-1 +| 1 | 2 | 3 | +| 5 | 6 | 7 | +| 9 | 14 | 11 | + +#+BEGIN_SRC calc :results silent :var a=ob-calc-table-1 + inv(a) +#+END_SRC " + (should (equal "[[-1, 0.625, -0.125], [0.25, -0.5, 0.25], [0.5, 0.125, -0.125]]" + (org-babel-execute-src-block))))) + +(ert-deftest ob-calc/matrix-algebra () + "Test of simple matrix algebra." + (org-test-with-temp-text "\ +#+NAME: ob-calc-table-2 +| 1 | 2 | 3 | 4 | 5 | + +#+BEGIN_SRC calc :results silent :var a=ob-calc-table-2 + a*2 - 2 +#+END_SRC" + (should (equal "[0, 2, 4, 6, 8]" + (org-babel-execute-src-block))))) + +(ert-deftest ob-calc/matrix-mean () + "Test of simple mean of a vector." + (org-test-with-temp-text "\ +#+NAME: ob-calc-table-2 +| 1 | 2 | 3 | 4 | 5 | + +#+BEGIN_SRC calc :results silent :var a=ob-calc-table-2 + vmean(a) +#+END_SRC" + (should (equal "3" + (org-babel-execute-src-block))))) + +(ert-deftest ob-calc/matrix-correct-conv-column () + "Test of conversion of column table to Calc format." + (org-test-with-temp-text "\ +#+NAME: ob-calc-table-3 +| 1 | +| 2 | +| 3 | + +#+BEGIN_SRC calc :results silent :var a=ob-calc-table-3 + a +#+END_SRC" + (should (equal "[[1], [2], [3]]" + (org-babel-execute-src-block))))) + +(ert-deftest ob-calc/matrix-correct-conv-row () + "Test of conversion of row table to Calc format." + (org-test-with-temp-text "\ +#+NAME: ob-calc-table-2 +| 1 | 2 | 3 | 4 | 5 | + +#+BEGIN_SRC calc :results silent :var a=ob-calc-table-2 + a +#+END_SRC" + (should (equal "[1, 2, 3, 4, 5]" + (org-babel-execute-src-block))))) + +(provide 'test-ob-calc) +;;; test-ob-calc.el ends here -- 2.43.0 --=-=-=--