Skip to content

Add serialization support for mutli-dimensional arrays #782

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.

Sign up for GitHub

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

Merged
merged 8 commits into from
May 11, 2020
Merged

Add serialization support for mutli-dimensional arrays #782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c3b90fe
Add quantity LinearPowerDensity
trb5016 Mar 5, 2020
44c9de2
Merge branch 'master' of https://github.com/angularsen/UnitsNet
trb5016 Mar 9, 2020
859dda4
Merge branch 'master' of https://github.com/angularsen/UnitsNet
Mar 29, 2020
a907894
Add combinations of Area, Density, and LinearDensity operators
Mar 29, 2020
c9d71d1
Changed operator overloads for Area, Density, and LinearDensity to SI…
Mar 29, 2020
a8fb5f6
Merge remote-tracking branch 'upstream/master'
May 8, 2020
0970155
Add serialization support for multi-dimensional arrays
May 9, 2020
f48deed
Addressed comments from PR 782
May 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions UnitsNet.Serialization.JsonNet.CompatibilityTests/UnitsNetJsonConverterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,39 @@ public void ArrayOfUnits_ExpectCorrectlyDeserialized()
Assert.Equal(expected, result);
}

[Fact(Skip = "Not supported in older versions of serialization")]
public void MultiDimArrayOfUnits_ExpectCorrectlyDeserialized()
{
Frequency[,] expected = { { Frequency.FromHertz(10), Frequency.FromHertz(10) }, { Frequency.FromHertz(10), Frequency.FromHertz(10) } };

string json = "[\n" +
" [\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" },\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" }\n" +
" ],\n" +
" [\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" },\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" }\n" +
" ]\n" +
"]";

Frequency[,] result = DeserializeObject<Frequency[,]>(json);

Assert.Equal(expected, result);
}

[Fact(Skip = "Not supported in older versions of serialization")]
public void EmptyArray_ExpectCorrectlyDeserialized()
{
Expand Down
51 changes: 42 additions & 9 deletions UnitsNet.Serialization.JsonNet.Tests/UnitsNetJsonDeserializationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,21 +188,54 @@ public void ArrayOfUnits_ExpectCorrectlyDeserialized()
Frequency[] expected = { Frequency.FromHertz(10), Frequency.FromHertz(10) };

var json = "[\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" },\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" }\n" +
"]";
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" },\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" }\n" +
"]";

var result = DeserializeObject<Frequency[]>(json);

Assert.Equal(expected, result);
}

[Fact]
public void MultiDimArrayOfUnits_ExpectCorrectlyDeserialized()
{
Frequency[,] expected = { { Frequency.FromHertz(10), Frequency.FromHertz(10) }, { Frequency.FromHertz(10), Frequency.FromHertz(10) } };

var json = "[\n" +
" [\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" },\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" }\n" +
" ],\n" +
" [\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" },\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" }\n" +
" ]\n" +
"]";

var result = DeserializeObject<Frequency[,]>(json);

Assert.Equal(expected, result);
}

[Fact]
public void EmptyArray_ExpectCorrectlyDeserialized()
{
Expand Down
33 changes: 33 additions & 0 deletions UnitsNet.Serialization.JsonNet.Tests/UnitsNetJsonSerializationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,39 @@ public void ArrayValue_ExpectJsonArray()
Assert.Equal(expectedJson, json);
}

[Fact]
public void MultiDimArrayValue_ExpectJsonArray()
{
Frequency[,] testObj = { { Frequency.FromHertz(10), Frequency.FromHertz(10) }, { Frequency.FromHertz(10), Frequency.FromHertz(10) } };

string expectedJson = "[\n" +
" [\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" },\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" }\n" +
" ],\n" +
" [\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" },\n" +
" {\n" +
" \"Unit\": \"FrequencyUnit.Hertz\",\n" +
" \"Value\": 10.0\n" +
" }\n" +
" ]\n" +
"]";

string json = SerializeObject(testObj);

Assert.Equal(expectedJson, json);
}

[Fact]
public void EmptyArrayValue_ExpectJsonArray()
{
Expand Down
89 changes: 89 additions & 0 deletions UnitsNet.Serialization.JsonNet/Internal/MultiDimensionalArrayHelpers.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace UnitsNet.Serialization.JsonNet.Internal
{

/// <summary>
/// Helper class for working with and manipulating multi-dimension arrays based on their generic index.
/// </summary>
internal static class MultiDimensionalArrayHelpers
{

/// <summary>
/// Returns a new array of same Rank and Length as <paramref name="array"/> but with each element converted to <typeparamref name="TResult"/>
/// </summary>
/// <typeparam name="TResult"></typeparam>
/// <param name="array"></param>
/// <returns></returns>
public static Array ConvertArrayElements<TResult>(Array array)
{
var ret = Array.CreateInstance(typeof(TResult), LastIndex(array));
var ind = FirstIndex(array);

while (ind != null)
{
ret.SetValue((TResult)array.GetValue(ind), ind);
ind = NextIndex(array, ind);
}
return ret;
}

/// <summary>
/// Returns the index for the 'first' element in a multidimensional array.
///
/// 'First' is defined as the <see cref="Array.GetLowerBound(int)"/> for each rank of the <paramref name="array"/>
///
/// E.g., for a zero-based 5x5x5 array this method would return [0, 0, 0].
/// </summary>
/// <param name="array"></param>
/// <returns>1D integer array specifying the location of the first element in the multidimensional array</returns>
public static int[] FirstIndex(Array array)
{
return Enumerable.Range(0, array.Rank).Select(x => array.GetLowerBound(x)).ToArray();
}

/// <summary>
/// Returns the index for the 'last' element in a multidimensional array.
///
/// 'Last' is defined as the <see cref="Array.GetUpperBound(int)"/> for each rank of the <paramref name="array"/>
///
/// E.g., for a zero-based 5x5x5 array this method would return [4, 4, 4].
/// </summary>
/// <param name="array"></param>
/// <returns>1D integer array specifying the location of the last element in the multidimensional array</returns>
public static int[] LastIndex(Array array)
{
return Enumerable.Range(0, array.Rank).Select(x => array.GetUpperBound(x) + 1).ToArray();
}

/// <summary>
/// Returns the 'next' index after the specified multidimensional <paramref name="index"/>
///
/// The 'next' index is determined by first looping through all elements in the first dimension of the array, then moving on to the next dimension and repeating
/// </summary>
/// <param name="array"></param>
/// <param name="index"></param>
/// <returns>Returns the index location of the next element in <paramref name="array"/> after <paramref name="index"/> as a 1D array of integers. If there is no next index, returns null</returns>
public static int[] NextIndex(Array array, int[] index)
{
for (var i = 0; i < index.Length; i++)
{
index[i] += 1;

if (index[i] <= array.GetUpperBound(i))
{
return index;
}
else
{
index[i] = array.GetLowerBound(i);
}
}
return null;
}

}
}
25 changes: 18 additions & 7 deletions UnitsNet.Serialization.JsonNet/UnitsNetJsonConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
using JetBrains.Annotations;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using UnitsNet.Serialization.JsonNet.Internal;

namespace UnitsNet.Serialization.JsonNet
{
Expand Down Expand Up @@ -44,15 +45,15 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
object obj = TryDeserializeIComparable(reader, serializer);
if (obj is Array values)
{
// Create array with the requested type, such as `Length[]` or `Frequency[]`
var arrayOfQuantities = Array.CreateInstance(objectType.GetElementType(), values.Length);

// Create array with the requested type, such as `Length[]` or `Frequency[]` or multi-dimensional arrays like `Length[,]` or `Frequency[,,]`
var arrayOfQuantities = Array.CreateInstance(objectType.GetElementType(), MultiDimensionalArrayHelpers.LastIndex(values));

// Fill array with parsed quantities
var i = 0;
foreach (ValueUnit valueUnit in values)
int[] index = MultiDimensionalArrayHelpers.FirstIndex(values);
while (index != null)
{
IQuantity quantity = ParseValueUnit(valueUnit);
arrayOfQuantities.SetValue(quantity, i++);
arrayOfQuantities.SetValue(values.GetValue(index), index);
}

return arrayOfQuantities;
Expand Down Expand Up @@ -148,7 +149,16 @@ public override void WriteJson(JsonWriter writer, object obj, JsonSerializer ser
}
else if (obj is Array values)
{
var results = values.Cast<IQuantity>().Select(ToValueUnit);

var results = Array.CreateInstance(typeof(ValueUnit), MultiDimensionalArrayHelpers.LastIndex(values));
var ind = MultiDimensionalArrayHelpers.FirstIndex(values);

while (ind != null)
{
results.SetValue((IQuantity)values.GetValue(ind), ind);
ind = MultiDimensionalArrayHelpers.NextIndex(results, ind);
}

serializer.Serialize(writer, results);
}
else if (obj is IQuantity quantity)
Expand Down Expand Up @@ -231,5 +241,6 @@ protected virtual bool CanConvertNullable(Type objectType)
}

#endregion

}
}