Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update package.d doc for median filter example #468

Merged
merged 1 commit into from
Apr 8, 2024
Merged

Conversation

aferust
Copy link
Contributor

@aferust aferust commented Mar 29, 2024

I only changed the code comments to update the median filter example for docs. did not touch anything else.

@jmh530
Copy link
Contributor

jmh530 commented Apr 1, 2024 via email

@aferust
Copy link
Contributor Author

aferust commented Apr 1, 2024

Why not use the median function from mir.math.stat? http://mir-algorithm.libmir.org/mir_math_stat.html#.median If I recall correctly, that text was from before mir.math.stat existed.

On Fri, Mar 29, 2024 at 4:18 AM aferust @.> wrote: I only changed the code comments to update the median filter example for docs. did not touch anything else. ________________________________ You can view, comment on, or merge this pull request online at: #468 Commit Summary 7c90d9a Update package.d doc for median filter example File Changes (1 file) M source/mir/ndslice/package.d (32) Patch Links: https://github.com/libmir/mir-algorithm/pull/468.patch https://github.com/libmir/mir-algorithm/pull/468.diff — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you are subscribed to this thread.Message ID: @.>

I believe the docs there are for explaining the usage of the ndslice not to show how to perform a median filter.

@9il 9il merged commit f3d0b7f into libmir:master Apr 8, 2024
21 of 26 checks passed
@9il
Copy link
Member

9il commented Apr 8, 2024

Thank you for the update! Unfortunately, my Circle CI account is under sanctions, and it doesn't update online docs anymore.

@aferust
Copy link
Contributor Author

aferust commented Apr 8, 2024

sorry to hear that. It is always weird that politics affects our lives in this way. There must be some third-party solutions for it.

@9il
Copy link
Member

9il commented Apr 8, 2024

There must be some third-party solutions for it.

Sure, it just needs some time. Mir's solution uses Circle CI + Docker + AWS. Circle CI is OK, but I don't have time to work on Mir anymore. It requires creating a new Circle CI account, setting up AWS keys in GitHub, and digging into the AWS setup, which I completely forgot.

I will accept changes if you or other Mir members want to transfer documentation generation to another AWS bucket and website.

@jmh530
Copy link
Contributor

jmh530 commented Apr 8, 2024

@9il I haven't had time to work on mir.stat lately, but when I was submitting PRs last year I didn't have any issues updating the documentation.

My understanding was that the documentation for mir.algorithm wasn't updating for other reasons than what you highlight. The issue may be that you're not able to see the results of the checks [1]. The checks have been failing for a while. Right now, this is what I see:

ninja: Entering directory `_build_dir_'
[1/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_algebraic.d.o
[2/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_bitmanip.d.o
[3/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_bitop.d.o
[4/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_checkedint.d.o
[5/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_complex_math.d.o
[6/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_complex_package.d.o
[7/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_conv.d.o
[8/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_enums.d.o
[9/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_exception.d.o
[10/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_functional.d.o
[11/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_internal_memory.d.o
[12/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_internal_meta.d.o
[13/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_internal_utility.d.o
[14/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_math_common.d.o
[15/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_math_constant.d.o
[16/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_math_ieee.d.o
[17/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_math_package.d.o
[18/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_primitives.d.o
[19/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_qualifier.d.o
[20/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_reflection.d.o
[21/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_string_table.d.o
[22/507] Compiling D object subprojects/mir-core/libmir-core.a.p/source_mir_utility.d.o
[23/507] Linking static target subprojects/mir-core/libmir-core.a
[24/507] Compiling D object libmir-algorithm.a.p/source_mir_algebraic_alias_ion.d.o
[25/507] Compiling D object libmir-algorithm.a.p/source_mir_algebraic_alias_json.d.o
[26/507] Compiling D object libmir-algorithm.a.p/source_mir_algebraic_alias_transform.d.o
[27/507] Compiling D object libmir-algorithm.a.p/source_mir_algorithm_iteration.d.o
[28/507] Compiling D object libmir-algorithm.a.p/source_mir_algorithm_setops.d.o
[29/507] Compiling D object libmir-algorithm.a.p/source_mir_annotated.d.o
[30/507] Compiling D object libmir-algorithm.a.p/source_mir_appender.d.o
[31/507] Compiling D object libmir-algorithm.a.p/source_mir_array_allocation.d.o
[32/507] Compiling D object libmir-algorithm.a.p/source_mir_base64.d.o
[33/507] Compiling D object libmir-algorithm.a.p/source_mir_bignum_decimal.d.o
[34/507] Compiling D object libmir-algorithm.a.p/source_mir_bignum_fixed.d.o
[35/507] Compiling D object libmir-algorithm.a.p/source_mir_bignum_fp.d.o
[36/507] Compiling D object libmir-algorithm.a.p/source_mir_bignum_integer.d.o
[37/507] Compiling D object libmir-algorithm.a.p/source_mir_bignum_internal_dec2float_table.d.o
[38/507] Compiling D object libmir-algorithm.a.p/source_mir_bignum_internal_dec2float.d.o
[39/507] Compiling D object libmir-algorithm.a.p/source_mir_bignum_internal_kernel.d.o
[40/507] Compiling D object libmir-algorithm.a.p/source_mir_bignum_internal_phobos_kernel.d.o
[41/507] Compiling D object libmir-algorithm.a.p/source_mir_bignum_internal_ryu_generic_128.d.o
[42/507] Compiling D object libmir-algorithm.a.p/source_mir_bignum_internal_ryu_table.d.o
[43/507] Compiling D object libmir-algorithm.a.p/source_mir_bignum_low_level_view.d.o
[44/507] Compiling D object libmir-algorithm.a.p/source_mir_combinatorics_package.d.o
[45/507] Compiling D object libmir-algorithm.a.p/source_mir_container_binaryheap.d.o
[46/507] Compiling D object libmir-algorithm.a.p/source_mir_cpp_export_numeric.d.o
[47/507] Compiling D object libmir-algorithm.a.p/source_mir_date.d.o
[48/507] Compiling D object libmir-algorithm.a.p/source_mir_ediff.d.o
[49/507] Compiling D object libmir-algorithm.a.p/source_mir_format_impl.d.o
[50/507] Compiling D object libmir-algorithm.a.p/source_mir_format.d.o
[51/507] Compiling D object libmir-algorithm.a.p/source_mir_graph_package.d.o
[52/507] Compiling D object libmir-algorithm.a.p/source_mir_graph_tarjan.d.o
[53/507] Compiling D object libmir-algorithm.a.p/source_mir_interpolate_constant.d.o
[54/507] Compiling D object libmir-algorithm.a.p/source_mir_interpolate_extrapolate.d.o
[55/507] Compiling D object libmir-algorithm.a.p/source_mir_interpolate_generic.d.o
[56/507] Compiling D object libmir-algorithm.a.p/source_mir_interpolate_linear.d.o
[57/507] Compiling D object libmir-algorithm.a.p/source_mir_interpolate_mod.d.o
[58/507] Compiling D object libmir-algorithm.a.p/source_mir_interpolate_package.d.o
[59/507] Compiling D object libmir-algorithm.a.p/source_mir_interpolate_polynomial.d.o
[60/507] Compiling D object libmir-algorithm.a.p/source_mir_interpolate_spline.d.o
[61/507] Compiling D object libmir-algorithm.a.p/source_mir_interpolate_utility.d.o
[62/507] Compiling D object libmir-algorithm.a.p/source_mir_lob.d.o
[63/507] Compiling D object libmir-algorithm.a.p/source_mir_math_func_expdigamma.d.o
[64/507] Compiling D object libmir-algorithm.a.p/source_mir_math_func_hermite.d.o
[65/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_internal.d.o
[66/507] Compiling D object libmir-algorithm.a.p/source_mir_math_func_normal.d.o
[67/507] Compiling D object libmir-algorithm.a.p/source_mir_math_numeric.d.o
[68/507] Compiling D object libmir-algorithm.a.p/source_mir_math_stat.d.o
[69/507] Compiling D object libmir-algorithm.a.p/source_mir_math_sum.d.o
[70/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_allocation.d.o
[71/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_chunks.d.o
[72/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_concatenation.d.o
[73/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_connect_cpython.d.o
[74/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_dynamic.d.o
[75/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_field.d.o
[76/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_filling.d.o
[77/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_fuse.d.o
[78/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_internal.d.o
[79/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_iterator.d.o
[80/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_mutation.d.o
[81/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_ndfield.d.o
[82/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_package.d.o
[83/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_slice.d.o
[84/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_sorting.d.o
[85/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_topology.d.o
[86/507] Compiling D object libmir-algorithm.a.p/source_mir_ndslice_traits.d.o
[87/507] Compiling D object libmir-algorithm.a.p/source_mir_numeric.d.o
[88/507] Compiling D object libmir-algorithm.a.p/source_mir_parse.d.o
[89/507] Compiling D object libmir-algorithm.a.p/source_mir_polynomial.d.o
[90/507] Compiling D object libmir-algorithm.a.p/source_mir_range.d.o
[91/507] Compiling D object libmir-algorithm.a.p/source_mir_rc_array.d.o
[92/507] Compiling D object libmir-algorithm.a.p/source_mir_rc_context.d.o
[93/507] Compiling D object libmir-algorithm.a.p/source_mir_rc_package.d.o
[94/507] Compiling D object libmir-algorithm.a.p/source_mir_rc_ptr.d.o
[95/507] Compiling D object libmir-algorithm.a.p/source_mir_rc_slim_ptr.d.o
[96/507] Compiling D object libmir-algorithm.a.p/source_mir_serde.d.o
[97/507] Compiling D object libmir-algorithm.a.p/source_mir_series.d.o
[98/507] Compiling D object libmir-algorithm.a.p/source_mir_small_array.d.o
[99/507] Compiling D object libmir-algorithm.a.p/source_mir_small_string.d.o
[100/507] Compiling D object libmir-algorithm.a.p/source_mir_string_map.d.o
[101/507] Compiling D object libmir-algorithm.a.p/source_mir_test.d.o
[102/507] Compiling D object libmir-algorithm.a.p/source_mir_timestamp.d.o
[103/507] Compiling D object libmir-algorithm.a.p/source_mir_type_info.d.o
[104/507] Compiling D object mir-algorithm-test.p/source_mir_bignum_integer.d.o
[105/507] Compiling D object mir-algorithm-test.p/source_mir_bignum_internal_dec2float_table.d.o
[106/507] Compiling D object mir-algorithm-test.p/source_mir_bignum_internal_dec2float.d.o
[107/507] Compiling D object mir-algorithm-test.p/source_mir_algebraic_alias_ion.d.o
[108/507] Compiling D object mir-algorithm-test.p/source_mir_algebraic_alias_json.d.o
[109/507] Linking static target libmir-algorithm.a
[110/507] Compiling D object mir-algorithm-test.p/source_mir_algebraic_alias_transform.d.o
[111/507] Compiling D object mir-algorithm-test.p/source_mir_algorithm_iteration.d.o
[112/507] Compiling D object mir-algorithm-test.p/source_mir_algorithm_setops.d.o
[113/507] Compiling D object mir-algorithm-test.p/source_mir_annotated.d.o
[114/507] Compiling D object mir-algorithm-test.p/source_mir_appender.d.o
[115/507] Compiling D object mir-algorithm-test.p/source_mir_array_allocation.d.o
[116/507] Compiling D object mir-algorithm-test.p/source_mir_base64.d.o
[117/507] Compiling D object mir-algorithm-test.p/source_mir_bignum_decimal.d.o
[118/507] Compiling D object mir-algorithm-test.p/source_mir_bignum_fixed.d.o
[119/507] Compiling D object mir-algorithm-test.p/source_mir_bignum_fp.d.o
[120/507] Compiling D object mir-algorithm-test.p/source_mir_bignum_internal_kernel.d.o
[121/507] Compiling D object mir-algorithm-test.p/source_mir_bignum_internal_phobos_kernel.d.o
[122/507] Compiling D object mir-algorithm-test.p/source_mir_bignum_internal_ryu_generic_128.d.o
[123/507] Compiling D object mir-algorithm-test.p/source_mir_bignum_internal_ryu_table.d.o
[124/507] Compiling D object mir-algorithm-test.p/source_mir_bignum_low_level_view.d.o
[125/507] Compiling D object mir-algorithm-test.p/source_mir_combinatorics_package.d.o
[126/507] Compiling D object mir-algorithm-test.p/source_mir_container_binaryheap.d.o
[127/507] Compiling D object mir-algorithm-test.p/source_mir_cpp_export_numeric.d.o
[128/507] Compiling D object mir-algorithm-test.p/source_mir_date.d.o
[129/507] Compiling D object mir-algorithm-test.p/source_mir_ediff.d.o
[130/507] Compiling D object mir-algorithm-test.p/source_mir_format_impl.d.o
[131/507] Compiling D object mir-algorithm-test.p/source_mir_format.d.o
[132/507] Compiling D object mir-algorithm-test.p/source_mir_graph_package.d.o
[133/507] Compiling D object mir-algorithm-test.p/source_mir_graph_tarjan.d.o
[134/507] Compiling D object mir-algorithm-test.p/source_mir_interpolate_constant.d.o
[135/507] Compiling D object mir-algorithm-test.p/source_mir_interpolate_extrapolate.d.o
[136/507] Compiling D object mir-algorithm-test.p/source_mir_interpolate_generic.d.o
[137/507] Compiling D object mir-algorithm-test.p/source_mir_interpolate_linear.d.o
[138/507] Compiling D object mir-algorithm-test.p/source_mir_interpolate_mod.d.o
[139/507] Compiling D object mir-algorithm-test.p/source_mir_interpolate_package.d.o
[140/507] Compiling D object mir-algorithm-test.p/source_mir_interpolate_polynomial.d.o
[141/507] Compiling D object mir-algorithm-test.p/source_mir_interpolate_spline.d.o
Warning: multivariate cubic spline with derivatives was not tested!!!
Warning: multivariate cubic spline with derivatives was not tested!!!
[142/507] Compiling D object mir-algorithm-test.p/source_mir_interpolate_utility.d.o
[143/507] Compiling D object mir-algorithm-test.p/source_mir_lob.d.o
[144/507] Compiling D object mir-algorithm-test.p/source_mir_math_func_expdigamma.d.o
[145/507] Compiling D object mir-algorithm-test.p/source_mir_math_func_hermite.d.o
[146/507] Compiling D object mir-algorithm-test.p/source_mir_math_func_normal.d.o
[147/507] Compiling D object mir-algorithm-test.p/source_mir_math_numeric.d.o
[148/507] Compiling D object mir-algorithm-test.p/source_mir_math_stat.d.o
[149/507] Compiling D object mir-algorithm-test.p/source_mir_math_sum.d.o
[150/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_allocation.d.o
[151/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_chunks.d.o
[152/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_concatenation.d.o
[153/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_connect_cpython.d.o
[154/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_dynamic.d.o
[155/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_field.d.o
[156/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_filling.d.o
[157/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_fuse.d.o
[158/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_iterator.d.o
[159/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_mutation.d.o
[160/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_ndfield.d.o
[161/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_package.d.o
[162/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_slice.d.o
[163/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_sorting.d.o
[164/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_topology.d.o
[165/507] Compiling D object mir-algorithm-test.p/source_mir_ndslice_traits.d.o
[166/507] Compiling D object mir-algorithm-test.p/source_mir_numeric.d.o
[167/507] Compiling D object mir-algorithm-test.p/source_mir_parse.d.o
[168/507] Compiling D object mir-algorithm-test.p/source_mir_polynomial.d.o
[169/507] Compiling D object mir-algorithm-test.p/source_mir_range.d.o
[170/507] Compiling D object mir-algorithm-test.p/source_mir_rc_array.d.o
[171/507] Compiling D object mir-algorithm-test.p/source_mir_rc_context.d.o
[172/507] Compiling D object mir-algorithm-test.p/source_mir_rc_package.d.o
[173/507] Compiling D object mir-algorithm-test.p/source_mir_rc_ptr.d.o
FAILED: mir-algorithm-test.p/source_mir_rc_ptr.d.o 
ldc2 -I=mir-algorithm-test.p -I=. -I=.. -I=../source -I=../include -I=../subprojects/mir-core/source -enable-color -wi -g -d-debug -preview=dip1008 -L=-lowmem -unittest -d-version=mir_test -d-version=mir_bignum_test -d-version=mir_bignum_test_llv -d-version=mir_ndslice_test -d-version=mir_secure_memory -makedeps=mir-algorithm-test.p/source_mir_rc_ptr.d.o.deps -of=mir-algorithm-test.p/source_mir_rc_ptr.d.o -c ../source/mir/rc/ptr.d
../source/mir/rc/ptr.d(279): Error: returning `createRCWithContext(context._get_value().s, move(context))` escapes a reference to parameter `context`
../source/mir/rc/ptr.d(279):        perhaps annotate the parameter with `return`
../source/mir/rc/ptr.d(425): Error: template instance `mir.rc.ptr.castTo!(S, C)` error instantiating
ninja: build stopped: subcommand failed.

Exited with code exit status 1

[1] https://app.circleci.com/pipelines/github/libmir/mir-algorithm/1749/workflows/d8a5144f-6a95-4673-8af2-d90089e68de6/jobs/2801

@9il
Copy link
Member

9il commented Apr 8, 2024

Wow, thank you for the great news! Then it is just really very outdated:

  • meson build scripts (list of files)
  • compiler versions in the docker images
  • documentation bugs

It's still a lot of work, but at least twice less than I thought.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants