diff --git a/examples/README.md b/examples/README.md index deeb4f53f..0063b9e8a 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,6 +1,9 @@ # V Scientific Library - Examples Directory 📚 -This directory contains various examples demonstrating the capabilities and usage of the V Scientific Library. Each example showcases different functionalities, from machine learning algorithms to plotting and mathematical computations. Below is a summary of the examples included in this directory: +This directory contains various examples demonstrating the capabilities and usage +of the V Scientific Library. Each example showcases different functionalities, +from machine learning algorithms to plotting and mathematical computations. +Below is a summary of the examples included in this directory: ## Machine Learning Examples 🤖 @@ -91,7 +94,11 @@ This directory contains various examples demonstrating the capabilities and usag ### Important Information ⚠️ -- Each example contains a `main.v` file with the V code demonstrating the specific functionality. -- Some examples include an additional `README.md` file. **You must read the `README.md` before running the example** to understand any prerequisites or specific instructions. +- Each example contains a `main.v` file with the V code demonstrating +the specific functionality. +- Some examples include an additional `README.md` file. +**You must read the `README.md` before running the example** to understand +any prerequisites or specific instructions. -To get started, navigate to the respective example directory and run the `main.v` file using the V compiler. +To get started, navigate to the respective example directory +and run the `main.v` file using the V compiler. diff --git a/examples/deriv_example/README.md b/examples/deriv_example/README.md index 3c28b51a0..1139a6e5a 100644 --- a/examples/deriv_example/README.md +++ b/examples/deriv_example/README.md @@ -1,6 +1,7 @@ # Example - deriv_example 📘 -This example demonstrates the usage of the V Scientific Library for demonstrating derivative calculation. +This example demonstrates the usage of the V Scientific Library +for demonstrating derivative calculation. ## Instructions diff --git a/examples/dist_histogram/README.md b/examples/dist_histogram/README.md index 60d2afc42..fd83f2e99 100644 --- a/examples/dist_histogram/README.md +++ b/examples/dist_histogram/README.md @@ -1,11 +1,13 @@ # Example - dist_histogram 📘 -This example demonstrates the usage of the V Scientific Library for creating a distribution histogram. +This example demonstrates the usage of the V Scientific Library +for creating a distribution histogram. ## Instructions 1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io). -2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! +2. Ensure you have the VSL installed. You can do it +following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! 3. Navigate to this directory. 4. Run the example using the following command: diff --git a/examples/fft_plot_example/README.md b/examples/fft_plot_example/README.md index a3a8e4842..6db29fc88 100644 --- a/examples/fft_plot_example/README.md +++ b/examples/fft_plot_example/README.md @@ -1,6 +1,7 @@ # Example - fft_plot_example 📘 -This example demonstrates the usage of the V Scientific Library for demonstrating Fast Fourier Transform (FFT) with plotting. +This example demonstrates the usage of the V Scientific Library +for demonstrating Fast Fourier Transform (FFT) with plotting. ## Instructions diff --git a/examples/io_h5_dataset/README.md b/examples/io_h5_dataset/README.md index e0be3c97f..bc1434206 100644 --- a/examples/io_h5_dataset/README.md +++ b/examples/io_h5_dataset/README.md @@ -1,11 +1,13 @@ # Example - io_h5_dataset 📘 -This example demonstrates the usage of the V Scientific Library for demonstrating HDF5 I/O for datasets. +This example demonstrates the usage of the V Scientific Library +for demonstrating HDF5 I/O for datasets. ## Instructions 1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io). -2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! +2. Ensure you have the VSL installed. You can do it +following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! 3. Navigate to this directory. 4. Run the example using the following command: diff --git a/examples/io_h5_relax/README.md b/examples/io_h5_relax/README.md index fe9b5e8ae..b4618978c 100644 --- a/examples/io_h5_relax/README.md +++ b/examples/io_h5_relax/README.md @@ -1,6 +1,7 @@ # Example - io_h5_relax 📘 -This example demonstrates the usage of the V Scientific Library for demonstrating HDF5 I/O for relaxation data. +This example demonstrates the usage of the V Scientific Library +for demonstrating HDF5 I/O for relaxation data. ## Instructions diff --git a/examples/iter_lazy_generation/README.md b/examples/iter_lazy_generation/README.md index 3b0bc80ba..b8c1dda6c 100644 --- a/examples/iter_lazy_generation/README.md +++ b/examples/iter_lazy_generation/README.md @@ -1,6 +1,7 @@ # Example - iter_lazy_generation 📘 -This example demonstrates the usage of the V Scientific Library for demonstrating lazy generation using iterators. +This example demonstrates the usage of the V Scientific Library +for demonstrating lazy generation using iterators. ## Instructions diff --git a/examples/la_triplet01/README.md b/examples/la_triplet01/README.md index e987cd7a9..a45200f41 100644 --- a/examples/la_triplet01/README.md +++ b/examples/la_triplet01/README.md @@ -1,6 +1,7 @@ # Example - la_triplet01 📘 -This example demonstrates the usage of the V Scientific Library for demonstrating linear algebra operations. +This example demonstrates the usage of the V Scientific Library +for demonstrating linear algebra operations. ## Instructions diff --git a/examples/ml_kmeans/README.md b/examples/ml_kmeans/README.md index 5f635d365..ff45c5d17 100644 --- a/examples/ml_kmeans/README.md +++ b/examples/ml_kmeans/README.md @@ -1,6 +1,7 @@ # Example - ml_kmeans 📘 -This example demonstrates the usage of the V Scientific Library for demonstrating the K-means clustering algorithm. +This example demonstrates the usage of the V Scientific Library +for demonstrating the K-means clustering algorithm. ## Instructions diff --git a/examples/ml_kmeans_plot/README.md b/examples/ml_kmeans_plot/README.md index 21855624f..d5cc605b9 100644 --- a/examples/ml_kmeans_plot/README.md +++ b/examples/ml_kmeans_plot/README.md @@ -1,6 +1,7 @@ # Example - ml_kmeans_plot 📘 -This example demonstrates the usage of the V Scientific Library for performing K-means clustering with plotting. +This example demonstrates the usage of the V Scientific Library +for performing K-means clustering with plotting. ## Instructions diff --git a/examples/ml_knn_plot/README.md b/examples/ml_knn_plot/README.md index 47472c8e6..4490f3dbb 100644 --- a/examples/ml_knn_plot/README.md +++ b/examples/ml_knn_plot/README.md @@ -1,6 +1,7 @@ # Example - ml_knn_plot 📘 -This example demonstrates the usage of the V Scientific Library for performing K-Nearest Neighbors algorithm with plotting. +This example demonstrates the usage of the V Scientific Library +for performing K-Nearest Neighbors algorithm with plotting. ## Instructions diff --git a/examples/ml_linreg01/README.md b/examples/ml_linreg01/README.md index 8e5955a4a..773b5b574 100644 --- a/examples/ml_linreg01/README.md +++ b/examples/ml_linreg01/README.md @@ -1,6 +1,7 @@ # Example - ml_linreg01 📘 -This example demonstrates the usage of the V Scientific Library for performing a basic linear regression. +This example demonstrates the usage of the V Scientific Library +for performing a basic linear regression. ## Instructions diff --git a/examples/ml_linreg02/README.md b/examples/ml_linreg02/README.md index 29cc85fb2..7ccd49931 100644 --- a/examples/ml_linreg02/README.md +++ b/examples/ml_linreg02/README.md @@ -1,6 +1,7 @@ # Example - ml_linreg02 📘 -This example demonstrates the usage of the V Scientific Library for performing an advanced linear regression. +This example demonstrates the usage of the V Scientific Library +for performing an advanced linear regression. ## Instructions diff --git a/examples/ml_linreg_plot/README.md b/examples/ml_linreg_plot/README.md index afee7f994..16c1b3da9 100644 --- a/examples/ml_linreg_plot/README.md +++ b/examples/ml_linreg_plot/README.md @@ -1,6 +1,7 @@ # Example - ml_linreg_plot 📘 -This example demonstrates the usage of the V Scientific Library for performing linear regression with plotting. +This example demonstrates the usage of the V Scientific Library +for performing linear regression with plotting. ## Instructions diff --git a/examples/ml_sentiment_analysis/README.md b/examples/ml_sentiment_analysis/README.md index aca5b2bf9..f73db9582 100644 --- a/examples/ml_sentiment_analysis/README.md +++ b/examples/ml_sentiment_analysis/README.md @@ -1,6 +1,7 @@ # Example - ml_sentiment_analysis 📘 -This example demonstrates the usage of the V Scientific Library for performing sentiment analysis using machine learning. +This example demonstrates the usage of the V Scientific Library +for performing sentiment analysis using machine learning. ## Instructions diff --git a/examples/mpi_basic_example/README.md b/examples/mpi_basic_example/README.md index 432504cd3..7a257bdbb 100644 --- a/examples/mpi_basic_example/README.md +++ b/examples/mpi_basic_example/README.md @@ -1,6 +1,7 @@ # Example - mpi_basic_example 📘 -This example demonstrates the usage of the V Scientific Library for demonstrating basic MPI functionality. +This example demonstrates the usage of the V Scientific Library +for demonstrating basic MPI functionality. ## Instructions diff --git a/examples/plot_heatmap_golden_ratio/README.md b/examples/plot_heatmap_golden_ratio/README.md index 39ec2c106..ecfe7129a 100644 --- a/examples/plot_heatmap_golden_ratio/README.md +++ b/examples/plot_heatmap_golden_ratio/README.md @@ -1,11 +1,13 @@ # Example - plot_heatmap_golden_ratio 📘 -This example demonstrates the usage of the V Scientific Library for creating a heatmap with the golden ratio. +This example demonstrates the usage of the V Scientific Library +for creating a heatmap with the golden ratio. ## Instructions 1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io). -2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! +2. Ensure you have the VSL installed. You can do it +following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! 3. Navigate to this directory. 4. Run the example using the following command: diff --git a/examples/plot_histogram/README.md b/examples/plot_histogram/README.md index 25e42a614..a519f8012 100644 --- a/examples/plot_histogram/README.md +++ b/examples/plot_histogram/README.md @@ -1,11 +1,13 @@ # Example - plot_histogram 📘 -This example demonstrates the usage of the V Scientific Library for showing how to create a histogram. +This example demonstrates the usage of the V Scientific Library +for showing how to create a histogram. ## Instructions 1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io). -2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! +2. Ensure you have the VSL installed. You can do it +following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! 3. Navigate to this directory. 4. Run the example using the following command: diff --git a/examples/plot_line_axis_titles/README.md b/examples/plot_line_axis_titles/README.md index 8ec387e4b..bfcc17089 100644 --- a/examples/plot_line_axis_titles/README.md +++ b/examples/plot_line_axis_titles/README.md @@ -1,6 +1,7 @@ # Example - plot_line_axis_titles 📘 -This example demonstrates the usage of the V Scientific Library for creating a line plot with axis titles. +This example demonstrates the usage of the V Scientific Library +for creating a line plot with axis titles. ## Instructions diff --git a/examples/plot_line_plot_with_areas/README.md b/examples/plot_line_plot_with_areas/README.md index 981174df5..71f8eaa66 100644 --- a/examples/plot_line_plot_with_areas/README.md +++ b/examples/plot_line_plot_with_areas/README.md @@ -1,11 +1,13 @@ # Example - plot_line_plot_with_areas 📘 -This example demonstrates the usage of the V Scientific Library for creating a line plot with shaded areas. +This example demonstrates the usage of the V Scientific Library +for creating a line plot with shaded areas. ## Instructions 1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io). -2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! +2. Ensure you have the VSL installed. You can do it +following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! 3. Navigate to this directory. 4. Run the example using the following command: diff --git a/examples/plot_scatter3d_1/README.md b/examples/plot_scatter3d_1/README.md index c1517cf6a..aed9f51d0 100644 --- a/examples/plot_scatter3d_1/README.md +++ b/examples/plot_scatter3d_1/README.md @@ -1,11 +1,13 @@ # Example - plot_scatter3d_1 📘 -This example demonstrates the usage of the V Scientific Library for creating a 3D scatter plot (example 1). +This example demonstrates the usage of the V Scientific Library for +creating a 3D scatter plot (example 1). ## Instructions 1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io). -2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! +2. Ensure you have the VSL installed. You can do it following +the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! 3. Navigate to this directory. 4. Run the example using the following command: diff --git a/examples/plot_scatter3d_2/README.md b/examples/plot_scatter3d_2/README.md index 8b2c82c5e..d5853e956 100644 --- a/examples/plot_scatter3d_2/README.md +++ b/examples/plot_scatter3d_2/README.md @@ -1,6 +1,7 @@ # Example - plot_scatter3d_2 📘 -This example demonstrates the usage of the V Scientific Library for creating a 3D scatter plot (example 2). +This example demonstrates the usage of the V Scientific Library +for creating a 3D scatter plot (example 2). ## Instructions diff --git a/examples/plot_scatter3d_easing/README.md b/examples/plot_scatter3d_easing/README.md index 52e104d7f..7c8146dd2 100644 --- a/examples/plot_scatter3d_easing/README.md +++ b/examples/plot_scatter3d_easing/README.md @@ -1,6 +1,7 @@ # Example - plot_scatter3d_easing 📘 -This example demonstrates the usage of the V Scientific Library for creating a 3D scatter plot with easing. +This example demonstrates the usage of the V Scientific Library +for creating a 3D scatter plot with easing. ## Instructions diff --git a/examples/plot_scatter_with_annotations/README.md b/examples/plot_scatter_with_annotations/README.md index bbe7e8164..9e750b95f 100644 --- a/examples/plot_scatter_with_annotations/README.md +++ b/examples/plot_scatter_with_annotations/README.md @@ -1,11 +1,13 @@ # Example - plot_scatter_with_annotations 📘 -This example demonstrates the usage of the V Scientific Library for creating a scatter plot with annotations. +This example demonstrates the usage of the V Scientific Library for creating +a scatter plot with annotations. ## Instructions 1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io). -2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! +2. Ensure you have the VSL installed. +You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! 3. Navigate to this directory. 4. Run the example using the following command: diff --git a/examples/plot_scatter_with_bars/README.md b/examples/plot_scatter_with_bars/README.md index 0e9f69a07..52dea8ee6 100644 --- a/examples/plot_scatter_with_bars/README.md +++ b/examples/plot_scatter_with_bars/README.md @@ -1,6 +1,7 @@ # Example - plot_scatter_with_bars 📘 -This example demonstrates the usage of the V Scientific Library for creating a scatter plot with bars. +This example demonstrates the usage of the V Scientific Library +for creating a scatter plot with bars. ## Instructions diff --git a/examples/plot_scatter_with_histogram/README.md b/examples/plot_scatter_with_histogram/README.md index 648aa8d55..5082070c8 100644 --- a/examples/plot_scatter_with_histogram/README.md +++ b/examples/plot_scatter_with_histogram/README.md @@ -1,11 +1,13 @@ # Example - plot_scatter_with_histogram 📘 -This example demonstrates the usage of the V Scientific Library for creating a scatter plot with histograms. +This example demonstrates the usage of the V Scientific Library +for creating a scatter plot with histograms. ## Instructions 1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io). -2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! +2. Ensure you have the VSL installed. You can do it +following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! 3. Navigate to this directory. 4. Run the example using the following command: diff --git a/examples/plot_scatter_with_regression/README.md b/examples/plot_scatter_with_regression/README.md index da5588c28..8a830cf0a 100644 --- a/examples/plot_scatter_with_regression/README.md +++ b/examples/plot_scatter_with_regression/README.md @@ -1,6 +1,7 @@ # Example - plot_scatter_with_regression 📘 -This example demonstrates the usage of the V Scientific Library for creating a scatter plot with regression line. +This example demonstrates the usage of the V Scientific Library +for creating a scatter plot with regression line. ## Instructions diff --git a/examples/plot_script_mode_ac_signal/README.md b/examples/plot_script_mode_ac_signal/README.md index d4873e78d..e4f5e61e3 100644 --- a/examples/plot_script_mode_ac_signal/README.md +++ b/examples/plot_script_mode_ac_signal/README.md @@ -1,6 +1,7 @@ # Example - plot_script_mode_ac_signal 📘 -This example demonstrates the usage of the V Scientific Library for plotting an AC signal in script mode. +This example demonstrates the usage of the V Scientific Library +for plotting an AC signal in script mode. ## Instructions diff --git a/examples/plot_script_mode_simple_plot/README.md b/examples/plot_script_mode_simple_plot/README.md index 9aaaea1d7..d56c092cc 100644 --- a/examples/plot_script_mode_simple_plot/README.md +++ b/examples/plot_script_mode_simple_plot/README.md @@ -1,6 +1,7 @@ # Example - plot_script_mode_simple_plot 📘 -This example demonstrates the usage of the V Scientific Library for creating a simple plot in script mode. +This example demonstrates the usage of the V Scientific Library +for creating a simple plot in script mode. ## Instructions diff --git a/examples/plot_script_mode_three_phase_signal/README.md b/examples/plot_script_mode_three_phase_signal/README.md index fc6f8fad6..ddf2ea1c1 100644 --- a/examples/plot_script_mode_three_phase_signal/README.md +++ b/examples/plot_script_mode_three_phase_signal/README.md @@ -1,11 +1,13 @@ # Example - plot_script_mode_three_phase_signal 📘 -This example demonstrates the usage of the V Scientific Library for plotting a three-phase signal in script mode. +This example demonstrates the usage of the V Scientific Library +for plotting a three-phase signal in script mode. ## Instructions 1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io). -2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! +2. Ensure you have the VSL installed. You can do it +following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! 3. Navigate to this directory. 4. Run the example using the following command: diff --git a/examples/plot_shaded_area_sin/README.md b/examples/plot_shaded_area_sin/README.md index 45ee03622..95ac176bc 100644 --- a/examples/plot_shaded_area_sin/README.md +++ b/examples/plot_shaded_area_sin/README.md @@ -1,11 +1,13 @@ # Example - plot_shaded_area_sin 📘 -This example demonstrates the usage of the V Scientific Library for creating a shaded area plot of the sine function. +This example demonstrates the usage of the V Scientific Library +for creating a shaded area plot of the sine function. ## Instructions 1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io). -2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! +2. Ensure you have the VSL installed. You can do it +following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)! 3. Navigate to this directory. 4. Run the example using the following command: diff --git a/examples/plot_sin_cos_surface/README.md b/examples/plot_sin_cos_surface/README.md index 9d6210252..77924ea8b 100644 --- a/examples/plot_sin_cos_surface/README.md +++ b/examples/plot_sin_cos_surface/README.md @@ -1,6 +1,7 @@ # Example - plot_sin_cos_surface 📘 -This example demonstrates the usage of the V Scientific Library for plotting the sine and cosine surface. +This example demonstrates the usage of the V Scientific Library +for plotting the sine and cosine surface. ## Instructions diff --git a/examples/plot_surface_easing/README.md b/examples/plot_surface_easing/README.md index a1820e673..f18e56d12 100644 --- a/examples/plot_surface_easing/README.md +++ b/examples/plot_surface_easing/README.md @@ -1,6 +1,7 @@ # Example - plot_surface_easing 📘 -This example demonstrates the usage of the V Scientific Library for plotting a surface with easing functions. +This example demonstrates the usage of the V Scientific Library +for plotting a surface with easing functions. ## Instructions diff --git a/examples/roots_bisection_solver/README.md b/examples/roots_bisection_solver/README.md index 7f8e212b5..3a0c7a709 100644 --- a/examples/roots_bisection_solver/README.md +++ b/examples/roots_bisection_solver/README.md @@ -1,6 +1,7 @@ # Example - roots_bisection_solver 📘 -This example demonstrates the usage of the V Scientific Library for finding roots using the bisection method. +This example demonstrates the usage of the V Scientific Library +for finding roots using the bisection method. ## Instructions diff --git a/examples/vcl_opencl_basic/README.md b/examples/vcl_opencl_basic/README.md index 74e1ed1d1..092cac13c 100644 --- a/examples/vcl_opencl_basic/README.md +++ b/examples/vcl_opencl_basic/README.md @@ -1,6 +1,7 @@ # Example - vcl_opencl_basic 📘 -This example demonstrates the usage of the V Scientific Library for demonstrating basic OpenCL functionality. +This example demonstrates the usage of the V Scientific Library +for demonstrating basic OpenCL functionality. ## Instructions diff --git a/examples/vcl_opencl_image_example/README.md b/examples/vcl_opencl_image_example/README.md index ac177d21b..4f3d8ad5b 100644 --- a/examples/vcl_opencl_image_example/README.md +++ b/examples/vcl_opencl_image_example/README.md @@ -8,4 +8,5 @@ This example shows how to do basic image processing with VCL using OpenCL as bac v run main.v ``` -after running it you should see the output image in the directory `output/` with the name `inverted.png`. +After running it, you should see the output image in the directory `output/` +with the name `inverted.png`.